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

Surface documentation about a URL in the query bar #1854

Closed
thewahome opened this issue Jun 23, 2022 · 1 comment · Fixed by #2219
Closed

Surface documentation about a URL in the query bar #1854

thewahome opened this issue Jun 23, 2022 · 1 comment · Fixed by #2219
Assignees
Labels
type:enhancement Enhancement request targeting an existing experience

Comments

@thewahome
Copy link
Collaborator

Is your feature request related to a problem? Please describe.
Sometimes I paste/type in/ accept suggestions for a URL and I need to know where to find the documentation about the query. With a minimized sidebar or an already slimmed-down sidebar due to responsiveness, I can't easily find the documentation since the icon is hidden.

Sometimes I do not even know where to start checking so that I find the documentation.

Describe the solution you'd like
image

The more info button has been surfacing this but we may need to expand the source of documentation links so that it can support urls that are outside of the set of sample queries.

We could change it to a documentation icon so that it only gives us information about documentation instead

Question
Since the documentation on docs already has the http requests in them, is there a way to reverse search the docs so that we can get the links that are related to the URL?

@thewahome thewahome self-assigned this Jun 23, 2022
@thewahome thewahome changed the title Search for documentation about a URL in the query bar Surface documentation about a URL in the query bar Jun 23, 2022
@darrelmiller
Copy link
Contributor

The work to make doc links made available in the OpenAPI description is ongoing here microsoft/OpenAPI.NET.OData#230

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:enhancement Enhancement request targeting an existing experience
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants