2022-04-04 11:22:00 +05:30
- name : "External status check API breaking changes"
announcement_milestone : "14.8"
2022-07-23 23:45:48 +05:30
announcement_date : "2022-02-22"
2022-04-04 11:22:00 +05:30
removal_milestone : "15.0"
removal_date : "2022-05-22"
breaking_change : true
reporter : sam.white
2022-05-07 20:08:51 +05:30
body : | # Do not modify this line, instead modify the lines below.
2022-04-04 11:22:00 +05:30
The [external status check API](https://docs.gitlab.com/ee/api/status_checks.html) was originally implemented to
support pass-by-default requests to mark a status check as passing. Pass-by-default requests are now deprecated.
Specifically, the following are deprecated :
- Requests that do not contain the `status` field.
- Requests that have the `status` field set to `approved`.
Beginning in GitLab 15.0, status checks will only be updated to a passing state if the `status` field is both present
2022-06-21 17:19:12 +05:30
and set to `passed`. Requests that :
2022-04-04 11:22:00 +05:30
- Do not contain the `status` field will be rejected with a `422` error. For more information, see [the relevant issue](https://gitlab.com/gitlab-org/gitlab/-/issues/338827).
2022-06-21 17:19:12 +05:30
- Contain any value other than `passed` will cause the status check to fail. For more information, see [the relevant issue](https://gitlab.com/gitlab-org/gitlab/-/issues/339039).
2022-04-04 11:22:00 +05:30
2022-06-21 17:19:12 +05:30
To align with this change, API calls to list external status checks will also return the value of `passed` rather than
2022-04-04 11:22:00 +05:30
`approved` for status checks that have passed.
# The following items are not published on the docs page, but may be used in the future.
stage : "Manage"
