Skip to content

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

Open
@MauriRohling

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

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions