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

Possibility of using the combination of API Method and API Path as URL fragment for navigating to particular API #2629

Open
harishav opened this issue Dec 5, 2024 · 0 comments

Comments

@harishav
Copy link

harishav commented Dec 5, 2024

Hi Team,

We see that OperationId can be used as URL fragment to navigate the user to the particular API within the API Documentation page as mentioned in this page.

I wanted to check if there is an option to use the combination of the API Method and API Path as an URL fragment to navigate ?

Reason being, if i want to point out the user to a particular API on the API Doc page from some user documentation page, i need to explicitly check the operation id and use that in the doc. Instead, it would be easy to just use the method and path, so that explicit mapping is not needed to be maintained.

Example:
If API is, GET /v1/products/{id}

Can the URL fragment be, #path/GET%20/v1/products/{id} ??

Thanks in Advance!

@harishav harishav changed the title Possibility of using the combination of API Method and API Path as URL fragment for navigation to particular API Possibility of using the combination of API Method and API Path as URL fragment for navigating to particular API Dec 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant