diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-07-14 15:09:14 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-07-14 15:09:14 +0300 |
commit | 49089d4fb1f5c17328ac61c955d95a68c6d4d545 (patch) | |
tree | 309d97ce6cbc1b22935dd0e11cc72abd767ffcf3 /doc/api/services.md | |
parent | 846a84f2e9d6149b00c63ccae2850421f6766bac (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api/services.md')
-rw-r--r-- | doc/api/services.md | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/doc/api/services.md b/doc/api/services.md index 145d83c62fa..c4bd5f86e43 100644 --- a/doc/api/services.md +++ b/doc/api/services.md @@ -493,6 +493,73 @@ Get Emails on push service settings for a project. GET /projects/:id/services/emails-on-push ``` +## Confluence service + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/220934) in GitLab 13.2. +> - It's deployed behind a feature flag, disabled by default. +> - It's disabled on GitLab.com. +> - It's able to be enabled or disabled per-project +> - 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-the-confluence-service-core-only). **(CORE ONLY)** + +Replaces the link to the internal wiki with a link to a Confluence Cloud Workspace. + +### Create/Edit Confluence service + +Set Confluence service for a project. + +```plaintext +PUT /projects/:id/services/confluence +``` + +Parameters: + +| Parameter | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `confluence_url` | string | true | The URL of the Confluence Cloud Workspace hosted on atlassian.net. | + +### Delete Confluence service + +Delete Confluence service for a project. + +```plaintext +DELETE /projects/:id/services/confluence +``` + +### Get Confluence service settings + +Get Confluence service settings for a project. + +```plaintext +GET /projects/:id/services/confluence +``` + +### Enable or disable the Confluence service **(CORE ONLY)** + +The Confluence service is 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 for your instance. The Confluence service can be enabled or disabled per-project + +To enable it: + +```ruby +# Instance-wide +Feature.enable(:confluence_integration) +# or by project +Feature.enable(:confluence_integration, Project.find(<project id>)) +``` + +To disable it: + +```ruby +# Instance-wide +Feature.disable(:confluence_integration) +# or by project +Feature.disable(:confluence_integration, Project.find(<project id>)) +``` + ## External Wiki Replaces the link to the internal wiki with a link to an external wiki. |