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

Documentation links are now broken #2828

Closed
baywet opened this issue Aug 4, 2023 · 1 comment
Closed

Documentation links are now broken #2828

baywet opened this issue Aug 4, 2023 · 1 comment

Comments

@baywet
Copy link

baywet commented Aug 4, 2023

It seems the documentation platform changed their link structure a couple of months ago.

The OpenAPI description contains
https://docs.github.com/en/rest/pulls?apiVersion=2022-11-28#list-pull-requests
Which used to get you down right to the API call sample, but now get's stuck on the table of content.

This is what the docs platform expects

https://docs.github.com/en/free-pro-team@latest/rest/pulls/pulls#create-a-pull-request

@nickfloyd
Copy link
Contributor

@baywet I checked the docs like you posted from the OpenAPI description, they were changed to support OpenAPI versioning.

I see what you mean - when linking directly to an operation the link in the descriptions seem to just default to the section and not the operation. So pulls instead of pulls#list-pull-requests

We'll have a look at what's going on and get a better idea of expected behavior. Thank you for catching this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants