Use metadata to reconcile go-github with GitHub's OpenAPI descriptions#2919
Merged
gmlewis merged 38 commits intogoogle:masterfrom Nov 3, 2023
Merged
Use metadata to reconcile go-github with GitHub's OpenAPI descriptions#2919gmlewis merged 38 commits intogoogle:masterfrom
gmlewis merged 38 commits intogoogle:masterfrom
Conversation
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.
see #2908
TODO before submitting for review:
This PR introduces a file called openapi_operations.yaml that contains details of GitHub's endpoints as described in https://github.com/github/rest-api-description. When combined with the
//meta:operationdirective, this allows us to automatically keep documentation links up to date, but more importantly it allows us to track endpoints as they are added and removed.The change set is huge, but it is primarily made up of openapi_operations.yaml itself and changes to godoc.
"tools/cmd/metadata" is a tool to manage metadata.yaml. I'll paste its help output here for convenience:
I'm trying to limit the scope of this PR because its line count is already pretty high. I will make a follow-up PR with a daily scheduled workflow that runs "update-openapi" and "update-go" and creates a PR if there are changes.