diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2024-01-11 15:09:29 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2024-01-11 15:09:29 +0300 |
commit | 97feef1f73fd0a3237d1a2aef4e977e7e27ecace (patch) | |
tree | 4153af3602f242ed1a138fe70bd843a2564dab19 /doc/api | |
parent | 6f5be4b446db2f17fc0307c4fce8ae285b35d89a (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/graphql/reference/index.md | 3 | ||||
-rw-r--r-- | doc/api/instance_level_ci_variables.md | 5 | ||||
-rw-r--r-- | doc/api/integrations.md | 130 | ||||
-rw-r--r-- | doc/api/settings.md | 2 |
4 files changed, 74 insertions, 66 deletions
diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index 02dde734f9a..e433277d560 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -15750,6 +15750,7 @@ CI/CD variables for a GitLab instance. | Name | Type | Description | | ---- | ---- | ----------- | +| <a id="ciinstancevariabledescription"></a>`description` | [`String`](#string) | Description of the variable. | | <a id="ciinstancevariableenvironmentscope"></a>`environmentScope` **{warning-solid}** | [`String`](#string) | **Deprecated** in 15.3. No longer used, only available for GroupVariableType and ProjectVariableType. | | <a id="ciinstancevariableid"></a>`id` | [`ID!`](#id) | ID of the variable. | | <a id="ciinstancevariablekey"></a>`key` | [`String`](#string) | Name of the variable. | @@ -16853,6 +16854,7 @@ The currently authenticated GitLab user. | <a id="currentusercommitemail"></a>`commitEmail` | [`String`](#string) | User's default commit email. | | <a id="currentusercreatedat"></a>`createdAt` | [`Time`](#time) | Timestamp of when the user was created. | | <a id="currentuserdiscord"></a>`discord` | [`String`](#string) | Discord ID of the user. | +| <a id="currentuserduochatavailable"></a>`duoChatAvailable` **{warning-solid}** | [`Boolean!`](#boolean) | **Introduced** in 16.8. This feature is an Experiment. It can be changed or removed at any time. User access to AI chat feature. | | <a id="currentuseremail"></a>`email` **{warning-solid}** | [`String`](#string) | **Deprecated** in 13.7. This was renamed. Use: [`User.publicEmail`](#userpublicemail). | | <a id="currentuseremails"></a>`emails` | [`EmailConnection`](#emailconnection) | User's email addresses. (see [Connections](#connections)) | | <a id="currentusergitpodenabled"></a>`gitpodEnabled` | [`Boolean`](#boolean) | Whether Gitpod is enabled at the user level. | @@ -20817,6 +20819,7 @@ CI/CD variables a project inherites from its parent group and ancestors. | Name | Type | Description | | ---- | ---- | ----------- | +| <a id="inheritedcivariabledescription"></a>`description` | [`String`](#string) | Description of the variable. | | <a id="inheritedcivariableenvironmentscope"></a>`environmentScope` | [`String`](#string) | Scope defining the environments that can use the variable. | | <a id="inheritedcivariablegroupcicdsettingspath"></a>`groupCiCdSettingsPath` | [`String`](#string) | Indicates the path to the CI/CD settings of the group the variable belongs to. | | <a id="inheritedcivariablegroupname"></a>`groupName` | [`String`](#string) | Indicates group the variable belongs to. | diff --git a/doc/api/instance_level_ci_variables.md b/doc/api/instance_level_ci_variables.md index a4018a46525..466479e0cdb 100644 --- a/doc/api/instance_level_ci_variables.md +++ b/doc/api/instance_level_ci_variables.md @@ -22,6 +22,7 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/a [ { "key": "TEST_VARIABLE_1", + "description": null, "variable_type": "env_var", "value": "TEST_1", "protected": false, @@ -30,6 +31,7 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/a }, { "key": "TEST_VARIABLE_2", + "description": null, "variable_type": "env_var", "value": "TEST_2", "protected": false, @@ -58,6 +60,7 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/a ```json { "key": "TEST_VARIABLE_1", + "description": null, "variable_type": "env_var", "value": "TEST_1", "protected": false, @@ -93,6 +96,7 @@ curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \ ```json { "key": "NEW_VARIABLE", + "description": null, "value": "new value", "variable_type": "env_var", "protected": false, @@ -126,6 +130,7 @@ curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \ ```json { "key": "NEW_VARIABLE", + "description": null, "value": "updated value", "variable_type": "env_var", "protected": true, diff --git a/doc/api/integrations.md b/doc/api/integrations.md index babb8ec40df..9aec4e0b17d 100644 --- a/doc/api/integrations.md +++ b/doc/api/integrations.md @@ -696,71 +696,6 @@ Get the GitHub integration settings for a project. GET /projects/:id/integrations/github ``` -## Slack notifications - -### Set up Slack notifications - -Set up Slack notifications for a project. - -```plaintext -PUT /projects/:id/integrations/slack -``` - -Parameters: - -| Parameter | Type | Required | Description | -| --------- | ---- | -------- | ----------- | -| `webhook` | string | true | Slack notifications webhook (for example, `https://hooks.slack.com/services/...`). | -| `username` | string | false | Slack notifications username. | -| `channel` | string | false | Default channel to use if no other channel is configured. | -| `notify_only_broken_pipelines` | boolean | false | Send notifications for broken pipelines. | -| `notify_only_default_branch` | boolean | false | **Deprecated:** This parameter has been replaced with `branches_to_be_notified`. | -| `branches_to_be_notified` | string | false | Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`. | -| `labels_to_be_notified` | string | false | Labels to send notifications for. Leave blank to receive notifications for all events. | -| `labels_to_be_notified_behavior` | string | false | Labels to be notified for. Valid options are `match_any` and `match_all`. The default value is `match_any`. | -| `alert_channel` | string | false | The name of the channel to receive notifications for alert events. | -| `alert_events` | boolean | false | Enable notifications for alert events. | -| `commit_events` | boolean | false | Enable notifications for commit events. | -| `confidential_issue_channel` | string | false | The name of the channel to receive notifications for confidential issue events. | -| `confidential_issues_events` | boolean | false | Enable notifications for confidential issue events. | -| `confidential_note_channel` | string | false | The name of the channel to receive notifications for confidential note events. | -| `confidential_note_events` | boolean | false | Enable notifications for confidential note events. | -| `deployment_channel` | string | false | The name of the channel to receive notifications for deployment events. | -| `deployment_events` | boolean | false | Enable notifications for deployment events. | -| `incident_channel` | string | false | The name of the channel to receive notifications for incident events. | -| `incidents_events` | boolean | false | Enable notifications for incident events. | -| `issue_channel` | string | false | The name of the channel to receive notifications for issue events. | -| `issues_events` | boolean | false | Enable notifications for issue events. | -| `job_events` | boolean | false | Enable notifications for job events. | -| `merge_request_channel` | string | false | The name of the channel to receive notifications for merge request events. | -| `merge_requests_events` | boolean | false | Enable notifications for merge request events. | -| `note_channel` | string | false | The name of the channel to receive notifications for note events. | -| `note_events` | boolean | false | Enable notifications for note events. | -| `pipeline_channel` | string | false | The name of the channel to receive notifications for pipeline events. | -| `pipeline_events` | boolean | false | Enable notifications for pipeline events. | -| `push_channel` | string | false | The name of the channel to receive notifications for push events. | -| `push_events` | boolean | false | Enable notifications for push events. | -| `tag_push_channel` | string | false | The name of the channel to receive notifications for tag push events. | -| `tag_push_events` | boolean | false | Enable notifications for tag push events. | -| `wiki_page_channel` | string | false | The name of the channel to receive notifications for wiki page events. | -| `wiki_page_events` | boolean | false | Enable notifications for wiki page events. | - -### Disable Slack notifications - -Disable Slack notifications for a project. Integration settings are reset. - -```plaintext -DELETE /projects/:id/integrations/slack -``` - -### Get Slack notifications settings - -Get the Slack notifications settings for a project. - -```plaintext -GET /projects/:id/integrations/slack -``` - ## Google Chat ### Set up Google Chat @@ -1423,6 +1358,71 @@ Get the Redmine integration settings for a project. GET /projects/:id/integrations/redmine ``` +## Slack notifications + +### Set up Slack notifications + +Set up Slack notifications for a project. + +```plaintext +PUT /projects/:id/integrations/slack +``` + +Parameters: + +| Parameter | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `webhook` | string | true | Slack notifications webhook (for example, `https://hooks.slack.com/services/...`). | +| `username` | string | false | Slack notifications username. | +| `channel` | string | false | Default channel to use if no other channel is configured. | +| `notify_only_broken_pipelines` | boolean | false | Send notifications for broken pipelines. | +| `notify_only_default_branch` | boolean | false | **Deprecated:** This parameter has been replaced with `branches_to_be_notified`. | +| `branches_to_be_notified` | string | false | Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`. | +| `labels_to_be_notified` | string | false | Labels to send notifications for. Leave blank to receive notifications for all events. | +| `labels_to_be_notified_behavior` | string | false | Labels to be notified for. Valid options are `match_any` and `match_all`. The default value is `match_any`. | +| `alert_channel` | string | false | The name of the channel to receive notifications for alert events. | +| `alert_events` | boolean | false | Enable notifications for alert events. | +| `commit_events` | boolean | false | Enable notifications for commit events. | +| `confidential_issue_channel` | string | false | The name of the channel to receive notifications for confidential issue events. | +| `confidential_issues_events` | boolean | false | Enable notifications for confidential issue events. | +| `confidential_note_channel` | string | false | The name of the channel to receive notifications for confidential note events. | +| `confidential_note_events` | boolean | false | Enable notifications for confidential note events. | +| `deployment_channel` | string | false | The name of the channel to receive notifications for deployment events. | +| `deployment_events` | boolean | false | Enable notifications for deployment events. | +| `incident_channel` | string | false | The name of the channel to receive notifications for incident events. | +| `incidents_events` | boolean | false | Enable notifications for incident events. | +| `issue_channel` | string | false | The name of the channel to receive notifications for issue events. | +| `issues_events` | boolean | false | Enable notifications for issue events. | +| `job_events` | boolean | false | Enable notifications for job events. | +| `merge_request_channel` | string | false | The name of the channel to receive notifications for merge request events. | +| `merge_requests_events` | boolean | false | Enable notifications for merge request events. | +| `note_channel` | string | false | The name of the channel to receive notifications for note events. | +| `note_events` | boolean | false | Enable notifications for note events. | +| `pipeline_channel` | string | false | The name of the channel to receive notifications for pipeline events. | +| `pipeline_events` | boolean | false | Enable notifications for pipeline events. | +| `push_channel` | string | false | The name of the channel to receive notifications for push events. | +| `push_events` | boolean | false | Enable notifications for push events. | +| `tag_push_channel` | string | false | The name of the channel to receive notifications for tag push events. | +| `tag_push_events` | boolean | false | Enable notifications for tag push events. | +| `wiki_page_channel` | string | false | The name of the channel to receive notifications for wiki page events. | +| `wiki_page_events` | boolean | false | Enable notifications for wiki page events. | + +### Disable Slack notifications + +Disable Slack notifications for a project. Integration settings are reset. + +```plaintext +DELETE /projects/:id/integrations/slack +``` + +### Get Slack notifications settings + +Get the Slack notifications settings for a project. + +```plaintext +GET /projects/:id/integrations/slack +``` + ## Slack slash commands ### Set up Slack slash commands diff --git a/doc/api/settings.md b/doc/api/settings.md index cf34cf3d65e..bde4c769b92 100644 --- a/doc/api/settings.md +++ b/doc/api/settings.md @@ -527,7 +527,7 @@ listed in the descriptions of the relevant settings. | `protected_ci_variables` | boolean | no | CI/CD variables are protected by default. | | `disable_overriding_approvers_per_merge_request` | boolean | no | Prevent editing approval rules in projects and merge requests | | `prevent_merge_requests_author_approval` | boolean | no | Prevent approval by author | -| `prevent_merge_requests_committers_approval` | boolean | no | Prevent editing approval rules in projects and merge requests | +| `prevent_merge_requests_committers_approval` | boolean | no | Prevent approval by committers to merge requests | | `push_event_activities_limit` | integer | no | Maximum number of changes (branches or tags) in a single push above which a [bulk push event is created](../administration/settings/push_event_activities_limit.md). Setting to `0` does not disable throttling. | | `push_event_hooks_limit` | integer | no | Maximum number of changes (branches or tags) in a single push above which webhooks and integrations are not triggered. Setting to `0` does not disable throttling. | | `rate_limiting_response_text` | string | no | When rate limiting is enabled via the `throttle_*` settings, send this plain text response when a rate limit is exceeded. 'Retry later' is sent if this is blank. | |