[Schema Inaccuracy] Invalid Authorization method specified for Updating a check-run

Open
#4,290 2 comments 1 reaction 0 assignees View on GitHub

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

documentation inaccuracy

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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github/rest-api-description

All issues in github/rest-api-description

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.