-
Notifications
You must be signed in to change notification settings - Fork 66.6k
Body parameters missing from "Create a check run" REST API docs #43652
Copy link
Copy link
Open
Labels
contentThis issue or pull request belongs to the Docs Content teamThis issue or pull request belongs to the Docs Content teamtriageDo not begin working on this issue until triaged by the teamDo not begin working on this issue until triaged by the team
Description
Code of Conduct
- I have read and agree to the GitHub Docs project's 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:
Here is the documentation for the body parameters, it only specifies the status parameter:
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:
Additional information
The body parameters are also missing from the GHEC and GHES docs.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
contentThis issue or pull request belongs to the Docs Content teamThis issue or pull request belongs to the Docs Content teamtriageDo not begin working on this issue until triaged by the teamDo not begin working on this issue until triaged by the team
Type
Fields
Give feedbackNo fields configured for issues without a type.