diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-06-17 12:09:53 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-06-17 12:09:53 +0300 |
commit | 612bb6f624ea7fdf5fd20e3332d543191603db88 (patch) | |
tree | 0540ef31b097382b8fd974cc4c41d1938d8caae4 /doc/api/status_checks.md | |
parent | af4364040394d0261c8b1c5f78ca60cc1e68e43c (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api/status_checks.md')
-rw-r--r-- | doc/api/status_checks.md | 81 |
1 files changed, 30 insertions, 51 deletions
diff --git a/doc/api/status_checks.md b/doc/api/status_checks.md index f4e384a2efb..75be51f5606 100644 --- a/doc/api/status_checks.md +++ b/doc/api/status_checks.md @@ -11,7 +11,7 @@ type: reference, api > - It's [deployed behind a feature flag](../user/feature_flags.md), disabled by default. > - It's disabled on GitLab.com. > - It's not recommended for production use. -> - To use it in GitLab self-managed instances, ask a GitLab administrator to [enable it](#enable-or-disable-status-checks). **(ULTIMATE SELF)** +> - To use it in GitLab self-managed instances, ask a GitLab administrator to [enable it](#enable-or-disable-external-status-checks). WARNING: This feature might not be available to you. Check the **version history** note above for details. @@ -67,13 +67,6 @@ POST /projects/:id/merge_requests/:merge_request_iid/status_check_responses NOTE: `sha` must be the SHA at the `HEAD` of the merge request's source branch. -## Enable or disable status checks **(ULTIMATE SELF)** - -Status checks are under development and not ready for production use. It is -deployed behind a feature flag that is **disabled by default**. -[GitLab administrators with access to the GitLab Rails console](../administration/feature_flags.md) -can enable it. - ## Get project external status checks **(ULTIMATE)** You can request information about a project's external status checks using the following endpoint: @@ -86,7 +79,7 @@ GET /projects/:id/external_status_checks | Attribute | Type | Required | Description | |---------------------|---------|----------|---------------------| -| `id` | integer | yes | The ID of a project | +| `id` | integer | yes | ID of a project | ```json [ @@ -109,7 +102,7 @@ GET /projects/:id/external_status_checks ] ``` -### Create external status check **(ULTIMATE)** +## Create external status check **(ULTIMATE)** You can create a new external status check for a project using the following endpoint: @@ -117,14 +110,14 @@ You can create a new external status check for a project using the following end POST /projects/:id/external_status_checks ``` -| Attribute | Type | Required | Description | -|------------------------|----------------|----------|----------------------------------------------------| -| `id` | integer | yes | The ID of a project | -| `name` | string | yes | Display name of status check | -| `external_url` | string | yes | URL of status check resource | -| `protected_branch_ids` | `array<Integer>` | no | The ids of protected branches to scope the rule by | +| Attribute | Type | Required | Description | +|------------------------|------------------|----------|------------------------------------------------| +| `id` | integer | yes | ID of a project | +| `name` | string | yes | Display name of status check | +| `external_url` | string | yes | URL of status check resource | +| `protected_branch_ids` | `array<Integer>` | no | IDs of protected branches to scope the rule by | -### Delete external status check **(ULTIMATE)** +## Delete external status check **(ULTIMATE)** You can delete an external status check for a project using the following endpoint: @@ -132,12 +125,12 @@ You can delete an external status check for a project using the following endpoi DELETE /projects/:id/external_status_checks/:check_id ``` -| Attribute | Type | Required | Description | -|------------------------|----------------|----------|----------------------------------------------------| -| `rule_id` | integer | yes | The ID of an status check | -| `id` | integer | yes | The ID of a project | +| Attribute | Type | Required | Description | +|------------------------|----------------|----------|-----------------------| +| `rule_id` | integer | yes | ID of an status check | +| `id` | integer | yes | ID of a project | -### Update external status check **(ULTIMATE)** +## Update external status check **(ULTIMATE)** You can update an existing external status check for a project using the following endpoint: @@ -145,18 +138,22 @@ You can update an existing external status check for a project using the followi PUT /projects/:id/external_status_checks/:check_id ``` -| Attribute | Type | Required | Description | -|------------------------|----------------|----------|----------------------------------------------------| -| `id` | integer | yes | The ID of a project | -| `rule_id` | integer | yes | The ID of an external status check | -| `name` | string | no | Display name of status check | -| `external_url` | string | no | URL of external status check resource | -| `protected_branch_ids` | `array<Integer>` | no | The ids of protected branches to scope the rule by | +| Attribute | Type | Required | Description | +|------------------------|------------------|----------|------------------------------------------------| +| `id` | integer | yes | ID of a project | +| `rule_id` | integer | yes | ID of an external status check | +| `name` | string | no | Display name of status check | +| `external_url` | string | no | URL of external status check resource | +| `protected_branch_ids` | `array<Integer>` | no | IDs of protected branches to scope the rule by | -### Enable or disable External Project-level MR status checks **(ULTIMATE SELF)** +## Enable or disable external status checks **(ULTIMATE SELF)** -Enable or disable External Project-level MR status checks is under development and not ready for production use. It is -deployed behind a feature flag that is **disabled by default**. +External status checks are: + +- Under development. +- Not ready for production use. + +The feature is deployed behind a feature flag that is **disabled by default**. [GitLab administrators with access to the GitLab Rails console](../user/feature_flags.md) can enable it. @@ -178,24 +175,6 @@ Feature.disable(:ff_compliance_approval_gates) Feature.disable(:ff_compliance_approval_gates, Project.find(<project id>)) ``` -To enable it: - -```ruby -# For the instance -Feature.enable(:ff_compliance_approval_gates) -# For a single project -Feature.enable(:ff_compliance_approval_gates, Project.find(<project id>)) -``` - -To disable it: - -```ruby -# For the instance -Feature.disable(:ff_compliance_approval_gates) -# For a single project -Feature.disable(:ff_compliance_approval_gates, Project.find(<project id>) -``` - ## Related links -- [External status checks](../user/project/merge_requests/status_checks.md) +- [External status checks](../user/project/merge_requests/status_checks.md). |