feat: maintain compatibility with octokit/openapi v8.0.0 and later by querying against the ghec schema bundle
#78
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This repository uses data generated and stored in `octokit/openapi`. Where one API version has an operation and another doesn't, then we add a special operation entry representing the missing operation. This is done in the [`addRemovedOperations` method][1]. When these special operation entries are added, they doesn't have the `X-GitHub` extension data included. Currently, we expect that to be there and blow up if it isn't. This makes the code more tolerant. [1]: https://github.com/octokit/openapi/blob/65f7b1ce4f0d90fa1db433d7f0904ecd6cc3bdc4/scripts/build.js#L413
versions v8.0.0 onwards As of v8.0.0 of `octokit/openapi`, the `api.github.com` bundle does not include API operations exclusive to GitHub Enterprise Cloud. If you want to see the GHEC-exclusive operations and all of the other normal ones, you have to look at the `ghec` bundle. This points our GraphQL queries to use the `ghec` bundle if the requested version is on or after v8.0.0. This will ensure that all expected operations are returned, and you can still filter them to find the ones you care about using the `githubCloudOnly` input.
timrogers
force-pushed
the
timrogers/ghec
branch
from
4e0e5ef
to
45120a3
Compare
timrogers
changed the title
ghec schema bundle when querying data in octokit/openapi v8.0.0 and lateroctokit/openapi v8.0.0 and later by querying against the ghec schema bundle
gr2m
reviewed
Sep 23, 2022
|
🎉 This PR is included in version 2.2.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As of
v8.0.0ofoctokit/openapi, theapi.git.luolix.topbundle does not include API operations exclusive to GitHub Enterprise Cloud.If you want to see the GHEC-exclusive operations and all of the other normal ones, you have to look at the
ghecbundle, not theapi.git.luolix.topone.This points our GraphQL queries to use the
ghecbundle if the requested version is on or after v8.0.0. This will ensure that all expected operations are returned, and you can still filter them to find the ones you care about using thegithubCloudOnlyinput.