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

Question : How to support X-GitHub-Api-Version #2359

Open
filipvh opened this issue Nov 30, 2022 · 4 comments
Open

Question : How to support X-GitHub-Api-Version #2359

filipvh opened this issue Nov 30, 2022 · 4 comments
Labels
Status: Up for grabs Issues that are ready to be worked on by anyone Type: Support Any questions, information, or general needs around the SDK or GitHub APIs

Comments

@filipvh
Copy link

filipvh commented Nov 30, 2022

I had some questions after the launch of the new versioning scheme: GitHub Blog - To infinity and beyond: enabling the future of GitHub’s REST API with API versioning

My main question is: how will this be supported by this library that I use?

I've been searching a bit, but have yet to find some relevant information. In the blogpost there might be one sentence about it, but not really helpful.

Any info, even pointing out there is none, would be helpful! Thanks!

@wolfy1339
Copy link
Member

Currently there isn't a way to define the API version per say.

If you want to use it, as it's it a header, you can add it to the options when you call the Octokit class.

Feel free to send a PR to add a proper option for this though

@wolfy1339 wolfy1339 added the Type: Support Any questions, information, or general needs around the SDK or GitHub APIs label Nov 30, 2022
@kfcampbell kfcampbell added Status: Up for grabs Issues that are ready to be worked on by anyone Priority: Normal labels Dec 1, 2022
@jonasfroeller
Copy link

jonasfroeller commented Mar 2, 2024

Does the GraphQL API have consistent versions? In other words, are they released simultaneously each time? Does this mean I can request it using the same version header: "X-GitHub-Api-Version": "2022-11-28"?

@wolfy1339
Copy link
Member

That header is only applicable to the REST endpoints. The GraphQL endpoint doesn't use it

@gr2m
Copy link
Contributor

gr2m commented Mar 3, 2024

GraphQL has the ability to deprecate APIs built-in already

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Up for grabs Issues that are ready to be worked on by anyone Type: Support Any questions, information, or general needs around the SDK or GitHub APIs
Projects
None yet
Development

No branches or pull requests

6 participants