diff options
Diffstat (limited to 'data/deprecations/15-6-deprecate-merge_status-api-field.yml')
| -rw-r--r-- | data/deprecations/15-6-deprecate-merge_status-api-field.yml | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/data/deprecations/15-6-deprecate-merge_status-api-field.yml b/data/deprecations/15-6-deprecate-merge_status-api-field.yml new file mode 100644 index 00000000000..55a7cce0b6c --- /dev/null +++ b/data/deprecations/15-6-deprecate-merge_status-api-field.yml @@ -0,0 +1,15 @@ +- name: "merge_status API field" # The name of the feature to be deprecated + announcement_milestone: "15.6" # The milestone when this feature was first announced as deprecated. + announcement_date: "2022-11-22" # The date of the milestone release when this feature was first announced as deprecated. This should almost always be the 22nd of a month (YYYY-MM-22), unless you did an out of band blog post. + removal_milestone: "16.0" # The milestone when this feature is planned to be removed + removal_date: "2023-05-22" # the date of the milestone release when this feature is planned to be removed + breaking_change: true # If this deprecation is a breaking change, set this value to true + body: | # Do not modify this line, instead modify the lines below. + The `merge_status` field in the [merge request API](https://docs.gitlab.com/ee/api/merge_requests.html#merge-status) has been deprecated in favor of the `detailed_merge_status` field which more correctly identifies all of the potential statuses that a merge request can be in. API users are encouraged to use the new `detailed_merge_status` field instead. The `merge_status` field will be removed in v5 of the GitLab REST API. +# The following items are not published on the docs page, but may be used in the future. + stage: create # (optional - may be required in the future) String value of the stage that the feature was created in. e.g., Growth + tiers: # (optional - may be required in the future) An array of tiers that the feature is available in currently. e.g., [Free, Silver, Gold, Core, Premium, Ultimate] + issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/382032 # (optional) This is a link to the deprecation issue in GitLab + documentation_url: https://docs.gitlab.com/ee/api/merge_requests.html#merge-status # (optional) This is a link to the current documentation page + image_url: # (optional) This is a link to a thumbnail image depicting the feature + video_url: # (optional) Use the youtube thumbnail URL with the structure of https://img.youtube.com/vi/UNIQUEID/hqdefault.jpg |