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

build(update): do not crash if a documented permission is not present in OpenAPI spec #262

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

gr2m
Copy link
Contributor

@gr2m gr2m commented Jan 31, 2025

this PR is currently blocked, see #262 (comment)

Copy link
Contributor

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labeled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

"DELETE": { "access": "write", "permission": "secrets" },
"PUT": { "access": "write", "permission": "secrets" }
"DELETE": { "access": "read", "permission": "metadata" },
"PUT": { "access": "read", "permission": "metadata" }
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should be write

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the docs are wrong:
https://docs.github.com/en/rest/authentication/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-metadata

The /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id} should not show up there at all. And meta data only has read, I'll look into it

@gr2m gr2m mentioned this pull request Jan 31, 2025
@gr2m
Copy link
Contributor Author

gr2m commented Feb 7, 2025

I'm putting this work on hold for now. Some findings

  • we should add the token type as it's now listed in the docs: User-to-Server Token (UAT) or Installation Access Token (IAT)
  • The same route might require multiple permissions or it can be accessed using one of multiple permissions. That means we need to change how the output of this repository is structured.

Also the current docs page has an incorrect section for "Metadata" which is tracked internally at https://github.com/github/docs-engineering/issues/5212

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🆕 Triage
Development

Successfully merging this pull request may close these issues.

1 participant