starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Improved search on the RestAPI docs page #6919

New Issue
Closed
opened 2025-12-29 19:46:41 +01:00 by adam · 5 comments
adam commented 2025-12-29 19:46:41 +01:00
Owner
Copy Link

Originally created by @D1StrX on GitHub (Sep 1, 2022).

NetBox version

v3.3.1

Feature type

Change to existing functionality

Proposed functionality

Improved search on the RestAPI docs page
Currently only tags are findable through the search option. Which then list all underlying options.
Would be nice if can support more specific search options. Thus when typing in Services it shows everything services related.
Currently:
image
Improved:
image
improved-search

Use case

Faster/easier lookup. Can search through collapsed tabs.

Database changes

I don't know. Probably yes.

External dependencies

Don't think so.

Originally created by @D1StrX on GitHub (Sep 1, 2022). ### NetBox version v3.3.1 ### Feature type Change to existing functionality ### Proposed functionality Improved search on the RestAPI docs page Currently only tags are findable through the search option. Which then list all underlying options. Would be nice if can support more specific search options. Thus when typing in Services it shows everything services related. Currently: ![image](https://user-images.githubusercontent.com/40062371/187951906-1aa39490-7454-4d32-8d98-91ba429ecc7b.png) Improved: ![image](https://user-images.githubusercontent.com/40062371/187927895-41737da5-4752-441e-b0b4-f403ee192730.png) improved-search ### Use case Faster/easier lookup. Can search through collapsed tabs. ### Database changes I don't know. Probably yes. ### External dependencies Don't think so.
adam added the type: featurepending closurestatus: under review labels 2025-12-29 19:46:41 +01:00
adam closed this issue 2025-12-29 19:46:42 +01:00
adam commented 2025-12-29 19:46:42 +01:00
Author
Owner
Copy Link

@kkthxbye-code commented on GitHub (Sep 1, 2022):

Upstream issue:

https://github.com/swagger-api/swagger-ui/issues/3876

Someone made a plugin snippet for filtering on title and description but I have no idea if it's the way to go. Looking at the age of the issue it doesn't seem like it's gonna be added upstream anytime soon.

@kkthxbye-code commented on GitHub (Sep 1, 2022): Upstream issue: https://github.com/swagger-api/swagger-ui/issues/3876 Someone made a plugin snippet for filtering [on title and description](https://github.com/swagger-api/swagger-ui/issues/3876#issuecomment-650697211) but I have no idea if it's the way to go. Looking at the age of the issue it doesn't seem like it's gonna be added upstream anytime soon.
adam commented 2025-12-29 19:46:43 +01:00
Author
Owner
Copy Link

@DanSheps commented on GitHub (Sep 6, 2022):

@D1StrX What @kkthxbye-code is trying to say is the swagger UI is completely generated by the swagger and is in no way (beyond us telling swagger what each serializer/view does) modifyable by us, outside of us getting into plugin development for swagger.

In sort, we can see if there is a way to improve this by hacking in our own Javascript plugin, but ultimately it is on the "upstream" package we use to properly implement this.

@DanSheps commented on GitHub (Sep 6, 2022): @D1StrX What @kkthxbye-code is trying to say is the swagger UI is completely generated by the swagger and is in no way (beyond us telling swagger what each serializer/view does) modifyable by us, outside of us getting into plugin development for swagger. In sort, we can see if there is a way to improve this by hacking in our own Javascript plugin, but ultimately it is on the "upstream" package we use to properly implement this.
adam commented 2025-12-29 19:46:43 +01:00
Author
Owner
Copy Link

@D1StrX commented on GitHub (Sep 6, 2022):

@DanSheps I completely understand. It would be, by Swagger native, logical to have such feature. Really appreciating if Netbox can supply a better implementation. Thanks in advance anyways!

@D1StrX commented on GitHub (Sep 6, 2022): @DanSheps I completely understand. It would be, by Swagger native, logical to have such feature. Really appreciating if Netbox can supply a better implementation. Thanks in advance anyways!
adam commented 2025-12-29 19:46:43 +01:00
Author
Owner
Copy Link

@github-actions[bot] commented on GitHub (Nov 6, 2022):

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Do not attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our contributing guide.

@github-actions[bot] commented on GitHub (Nov 6, 2022): This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. **Do not** attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our [contributing guide](https://github.com/netbox-community/netbox/blob/develop/CONTRIBUTING.md).
adam commented 2025-12-29 19:46:43 +01:00
Author
Owner
Copy Link

@github-actions[bot] commented on GitHub (Dec 7, 2022):

This issue has been automatically closed due to lack of activity. In an effort to reduce noise, please do not comment any further. Note that the core maintainers may elect to reopen this issue at a later date if deemed necessary.

@github-actions[bot] commented on GitHub (Dec 7, 2022): This issue has been automatically closed due to lack of activity. In an effort to reduce noise, please do not comment any further. Note that the core maintainers may elect to reopen this issue at a later date if deemed necessary.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label pending closure status: under review type: feature
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#6919
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?