[Schema Inaccuracy] Invalid Authorization method specified for Updating a check-run
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- openapi
- Domain
- api, documentation
Research direction
Start with the Update a check run endpoint documentation and review its authorization section, then identify the other endpoints with the same inaccurate fine-grained token wording. Done means removing unsupported fine-grained mentions and making the GitHub App restriction clear wherever the information is replicated.
Written by the indexing model from the issue text.
Description
Schema Inaccuracy
The GitHub REST API documentation for updating a check-run indicates that Fine-grained personal access tokens are a valid token type for this endpoint. However, using a fine-grained token as specified results in an HTTP 403 response with the message: "Resource not accessible by personal access token"
The documentation also mentions that it's necessary to give the "Checks" repository permissions (read) for the fine-grained token, but "Checks" is not one of the permission options available when creating this type of token.
Expected
Since at the beginning of the documentation it's stated that "Write permission for the REST API to interact with checks is only available to GitHub Apps", the behavior is working as expected, therefore the documentation only needs to be updated to remove the fine grained mentions on endpoints that require write permissions, the information is replicated for several endpoints.
Furthermore, it could also be made more evident that a check run can only be modified by the GitHub App that created it.
Reproduction Steps
N/A
- Dominant language
- No language data
- Stars
- 1.6k
- Forks
- 342
- Avg merge
- 3h 33m
- Merged PRs (30d)
- 51
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from github/rest-api-description
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
github/rest-api-description#7201 ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
github/rest-api-description#7163 ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
github/rest-api-description#7162 ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
github/rest-api-description#7135 ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
github/rest-api-description#7111 · 1 comment ·
All issues in github/rest-api-description
Similar issues
-
bug clawsweeper:linked-pr-open clawsweeper:needs-live-repro clawsweeper:no-new-fix-pr impact:message-loss issue-rating: 🐚 platinum hermit P2 regression
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
AXERA-TECH/ax-llm#77 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
games-on-whales/wolf#509 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100