-
Notifications
You must be signed in to change notification settings - Fork 65.9k
Description
Code of Conduct
- I have read and agree to the GitHub Docs project's Code of Conduct
What article on docs.github.com is affected?
What part(s) of the article would you like to see updated?
The GitHub REST API is versioned. The API version name is based on the date when the API version was released. For example, the API version
2022-11-28was released on Mon, 28 Nov 2022.
The rest api may be "versioned" but to say that the name is based on when the api version is released does not appear to match reality.
It might mean something like "the api version name is the name of a supported set of apis some of which may be released after this date, but whose behavior won't be intentionally changed in a breaking fashion until another api version name".
Any additive (non-breaking) changes will be available in all supported API versions. Additive changes are changes that should not break an integration.
The term integration isn't defined which doesn't help matters. GitHub periodically breaks my action by changing behavior, but I don't think it's seriously apologized for doing that. The pull_request_event handling was clearly a breaking change although I'm not quite sure how to prove it was observable to the rest api. I think it technically changed the field values for events which probably should satisfy the standard of "we broke it".
Additional information
No response