Changes to the Checks REST API

The following changes are being introduced to the Checks REST API and will take permanent effect on August 27th, 2018.

filename is being renamed to path

Previously, constructing an annotation required you to provide a filename value. However, more accurately, this argument is a path relative to the repository's root directory. As such, the argument you need to provide is being renamed to path.

We will continue to accept the filename argument for one week, after which, path will be required. Responses will also change to provide the path value.

blob_href is no longer necessary

Previously, constructing an annotation required you to also provide a blob_href value. This argument is no longer necessary. Responses will continue to provide the blob_href value.

warning_level is being renamed to annotation_level

Previously, constructing an annotation required you to provide a warning_level value. However, this argument name is not accurate, because an annotation can also be marked as another type, such as a failure or info. As such, the argument to provide is being renamed to annotation_level.

We will continue to accept the warning_level argument for one week, after which, annotation_level will be required. Responses will also change to provide the annotation_level value.

POST /repos/:owner/:repo/check-suite-requests is being removed

This endpoint allows you to create a check suite, or rerequest every single check suite that exists on a repository.

We're removing this endpoint because, from our observations on its usage, it's not useful to be able to trigger the creation of check suites for every App on the repository.

POST /repos/:owner/:repo/check-suites/:check_suite_id/rerequest is being added

As a replacement for the above, we have provided an endpoint to only allow for the rerequesting of a single check suite. This endpoint will trigger the check_run webhook event with the action rerequested. When a check suite is rerequested, its status is reset to queued and the conclusion is cleared.

Share your feedback

During the preview period, we may change aspects of these APIs based on developer feedback. If we do, we will announce the changes here on the developer blog, but we will not provide any advance notice.

If you have any questions or feedback, please let us know!