Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved search on the RestAPI docs page #10240

Closed
D1StrX opened this issue Sep 1, 2022 · 5 comments
Closed

Improved search on the RestAPI docs page #10240

D1StrX opened this issue Sep 1, 2022 · 5 comments
Labels
pending closure Requires immediate attention to avoid being closed for inactivity status: under review Further discussion is needed to determine this issue's scope and/or implementation type: feature Introduction of new functionality to the application

Comments

@D1StrX
Copy link

D1StrX commented 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.

@D1StrX D1StrX added the type: feature Introduction of new functionality to the application label Sep 1, 2022
@kkthxbye-code
Copy link
Contributor

Upstream issue:

swagger-api/swagger-ui#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.

@DanSheps
Copy link
Member

DanSheps commented 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 DanSheps added the status: under review Further discussion is needed to determine this issue's scope and/or implementation label Sep 6, 2022
@D1StrX
Copy link
Author

D1StrX commented 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!

@github-actions
Copy link
Contributor

github-actions bot commented 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 github-actions bot added the pending closure Requires immediate attention to avoid being closed for inactivity label Nov 6, 2022
@github-actions
Copy link
Contributor

github-actions bot commented 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 github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Dec 7, 2022
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 8, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
pending closure Requires immediate attention to avoid being closed for inactivity status: under review Further discussion is needed to determine this issue's scope and/or implementation type: feature Introduction of new functionality to the application
Projects
None yet
Development

No branches or pull requests

3 participants