diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2022-11-28 18:09:27 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2022-11-28 18:09:27 +0300 |
commit | 3a25b40d5572a1de4220a9bd284025bf5be1d16b (patch) | |
tree | 748ec93e09ada6def17ac87b4b8479dccab20d37 /doc | |
parent | 22fd199237e247c36de5b982d444cedc194126e6 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/product_analytics.md | 17 | ||||
-rw-r--r-- | doc/integration/mattermost/index.md | 4 |
2 files changed, 17 insertions, 4 deletions
diff --git a/doc/api/product_analytics.md b/doc/api/product_analytics.md index e10327bc59b..b7401f83128 100644 --- a/doc/api/product_analytics.md +++ b/doc/api/product_analytics.md @@ -16,12 +16,13 @@ This feature is not ready for production use. NOTE: Make sure to define the `cube_api_base_url` and `cube_api_key` application settings first using [the API](settings.md). -## Send request to Cube +## Send query request to Cube Generate an access token that can be used to query the Cube API. For example: ```plaintext POST /projects/:id/product_analytics/request/load +POST /projects/:id/product_analytics/request/dry-run ``` | Attribute | Type | Required | Description | @@ -30,7 +31,7 @@ POST /projects/:id/product_analytics/request/load ### Request body -The body of the request should be a valid Cube query. +The body of the load request should be a valid Cube query. ```json { @@ -66,3 +67,15 @@ The body of the request should be a valid Cube query. "queryType": "multi" } ``` + +## Send meta request to Cube + +Returns Cube Meta data for the Analytics data. For example: + +```plaintext +GET /projects/:id/product_analytics/request/meta +``` + +| Attribute | Type | Required | Description | +| --------- |------------------| -------- |---------------------------------------------------------------| +| `id` | integer | yes | The ID of a project that the current user has read access to. | diff --git a/doc/integration/mattermost/index.md b/doc/integration/mattermost/index.md index 04b0157b737..df6130a7540 100644 --- a/doc/integration/mattermost/index.md +++ b/doc/integration/mattermost/index.md @@ -123,7 +123,7 @@ http://mattermost.example.com/signup/gitlab/complete http://mattermost.example.com/login/gitlab/complete ``` -Note that you do not need to select any options under **Scopes**. Choose **Save application**. +Make sure to select the **Trusted** and **Confidential** settings. Under **Scopes**, select `read_user`. Then, choose **Save application**. Once the application is created you are provided with an `Application ID` and `Secret`. One other piece of information needed is the URL of GitLab instance. Return to the server running GitLab Mattermost and edit the `/etc/gitlab/gitlab.rb` configuration file as follows using the values you received above: @@ -132,7 +132,7 @@ Return to the server running GitLab Mattermost and edit the `/etc/gitlab/gitlab. mattermost['gitlab_enable'] = true mattermost['gitlab_id'] = "12345656" mattermost['gitlab_secret'] = "123456789" -mattermost['gitlab_scope'] = "" +mattermost['gitlab_scope'] = "read_user" mattermost['gitlab_auth_endpoint'] = "http://gitlab.example.com/oauth/authorize" mattermost['gitlab_token_endpoint'] = "http://gitlab.example.com/oauth/token" mattermost['gitlab_user_api_endpoint'] = "http://gitlab.example.com/api/v4/user" |