docs
docs copied to clipboard
rest: get latest release doesn't match publish latest(?) release
Code of Conduct
- [X] I have read and agree to the GitHub Docs project's Code of Conduct
What article on docs.github.com is affected?
https://docs.github.com/en/rest/releases/releases?apiVersion=2022-11-28#get-the-latest-release
What part(s) of the article would you like to see updated?
The latest release is the most recent non-prerelease, non-draft release, sorted by the created_at attribute. The created_at attribute is the date of the commit used for the release, and not the date when the release was drafted or published.
this does not match the producer api:
https://docs.github.com/en/rest/releases/releases?apiVersion=2022-11-28#create-a-release
make_latest
string
Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to true for newly published releases. legacy specifies that the latest release should be determined based on the release creation date and higher semantic version. Default:true
Can be one of:true
,false
,legacy
Additional information
No response
👋 @jsoref Thanks so much for opening an issue! I'll triage this for the team to take a look :eyes:
Thank you for opening this issue! Updates to the REST API, GraphQL API, and webhook reference documentation must be made internally. I have copied your issue to an internal issue, so I will close this issue.
@skedwards88: could someone please let me know when the docs change in response to this ticket? (If it were a public ticket tracking system, I'd get a notification when it was resolved, but @docubot closing it means I won't naturally get that information...)
I was actually looking for an API that would yield the latest sha (roughly what the make latest
api determines), so I'd like to read the new documentation and see if it covers the use case for which I was checking the documentation. (Someone asked me if there was a way to do this, and I looked... which led me here.)