Skip to content

Body parameters missing from "Create a check run" REST API docs #43652

@wheelerlaw

Description

@wheelerlaw

Code of Conduct

What article on docs.github.com is affected?

The "Create a check run" REST API documentation.

What part(s) of the article would you like to see updated?

The documentation for the "Create a check run" API endpoint seems to only include the status body parameter, whereas the request examples on the right includes several more body parameters.

Here is the request example, notice how there are many body parameters specified:

Image

Here is the documentation for the body parameters, it only specifies the status parameter:

Image

Not sure if the documentation is correct or the request example is correct, but my hunch is the latter.

If you check out documentation for the "Update a check run" section, you'll notice how the documented body parameters lines up with the request examples:

Image

Additional information

The body parameters are also missing from the GHEC and GHES docs.

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content teamtriageDo not begin working on this issue until triaged by the team

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions