migrate to GitHub "calendar-based versioning" for access to the GitHub REST API ('X-GitHub-Api-Version', etc.) #89
Labels
priority: 2 (soon)
severity: 4 (important)
status:acknowledged
type:task
Activity or change needed for ongoing care and feeding of the project
In late 2022, GitHub announced it was moving to "calendar-based versioning" for the GitHub REST API:
The announcement docs state:
The "Breaking Changes" doc linked above says:
And indeed, AFAIK there that change has not (yet?) caused any breakage for programs in the
ads-github-tools
project. However, the "API Versions" doc linked above also state:The
ads-github-tools
should adapt the newer approach, in order to avoid surprises in the future.The current version of
ads-github-tools
(version0.3.5
, released2022-10-26
) specifies the Media Type for the GitHub v3 API thus:The GitHub "API Versions" documentation now specifies that the desired version of the API should be specified in the newly added
X-GitHub-Api-Version
HTTP header rather than as part of the Media Type (in theAccept:
header):The Media Type (
Accept:
) header is still used to request specific types of content. The "Media types" docs say that most of the GitHub REST APIs support either:or:
But the accepted value(s) can vary for different endpoints, so you need to check the docs for each API endpoint.
FWIW, the docs for the
/user/repos
endpoint recommends:The text was updated successfully, but these errors were encountered: