From 5ee120f46740efac7b8a460d7a92e4da82f4fb0b Mon Sep 17 00:00:00 2001 From: GitLab Bot Date: Tue, 18 Feb 2020 03:08:54 +0000 Subject: Add latest changes from gitlab-org/gitlab@master --- doc/api/applications.md | 2 +- doc/api/discussions.md | 16 +++---- doc/api/issues.md | 8 ++-- doc/api/merge_requests.md | 4 +- doc/api/notes.md | 16 +++---- doc/api/oauth2.md | 33 ++++++++++++- doc/api/project_snippets.md | 4 +- doc/api/repository_files.md | 6 +-- doc/api/resource_label_events.md | 8 ++-- doc/api/search.md | 52 ++++++++++----------- doc/api/snippets.md | 2 +- .../bitbucket_integration.md | 2 +- doc/ci/triggers/README.md | 3 ++ .../issues/img/related_issue_block_v12_8.png | Bin 0 -> 117786 bytes doc/user/project/issues/img/related_issues_add.png | Bin 12900 -> 0 bytes .../issues/img/related_issues_add_v12_8.png | Bin 0 -> 105785 bytes .../project/issues/img/related_issues_remove.png | Bin 5450 -> 0 bytes .../issues/img/related_issues_remove_v12_8.png | Bin 0 -> 36051 bytes doc/user/project/issues/related_issues.md | 15 ++++-- 19 files changed, 107 insertions(+), 64 deletions(-) create mode 100644 doc/user/project/issues/img/related_issue_block_v12_8.png delete mode 100644 doc/user/project/issues/img/related_issues_add.png create mode 100644 doc/user/project/issues/img/related_issues_add_v12_8.png delete mode 100644 doc/user/project/issues/img/related_issues_remove.png create mode 100644 doc/user/project/issues/img/related_issues_remove_v12_8.png (limited to 'doc') diff --git a/doc/api/applications.md b/doc/api/applications.md index 37e0ad17e46..c7bfebb75fa 100644 --- a/doc/api/applications.md +++ b/doc/api/applications.md @@ -59,7 +59,7 @@ GET /applications Example request: ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/applications +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/applications ``` Example response: diff --git a/doc/api/discussions.md b/doc/api/discussions.md index 285d1699a95..22d615eba28 100644 --- a/doc/api/discussions.md +++ b/doc/api/discussions.md @@ -111,7 +111,7 @@ GET /projects/:id/issues/:issue_iid/discussions ``` ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/issues/11/discussions +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/issues/11/discussions ``` ### Get single issue discussion item @@ -131,7 +131,7 @@ Parameters: | `discussion_id` | integer | yes | The ID of a discussion item | ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/issues/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7 +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/issues/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7 ``` ### Create new issue thread @@ -319,7 +319,7 @@ GET /projects/:id/snippets/:snippet_id/discussions ``` ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/snippets/11/discussions +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/snippets/11/discussions ``` ### Get single snippet discussion item @@ -526,7 +526,7 @@ GET /groups/:id/epics/:epic_id/discussions ``` ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/groups/5/epics/11/discussions +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/groups/5/epics/11/discussions ``` ### Get single epic discussion item @@ -786,7 +786,7 @@ Diff comments contain also position: ``` ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions ``` ### Get single merge request discussion item @@ -806,7 +806,7 @@ Parameters: | `discussion_id` | integer | yes | The ID of a discussion item | ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7 +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7 ``` ### Create new merge request thread @@ -1079,7 +1079,7 @@ Diff comments contain also position: ``` ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/commits/11/discussions +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/commits/11/discussions ``` ### Get single commit discussion item @@ -1099,7 +1099,7 @@ Parameters: | `discussion_id` | integer | yes | The ID of a discussion item | ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/commits/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7 +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/commits/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7 ``` ### Create new commit thread diff --git a/doc/api/issues.md b/doc/api/issues.md index 9405851fb6f..b688a75ad67 100644 --- a/doc/api/issues.md +++ b/doc/api/issues.md @@ -1401,7 +1401,7 @@ GET /projects/:id/issues/:issue_iid/time_stats | `issue_iid` | integer | yes | The internal ID of a project's issue | ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/issues/93/time_stats +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/issues/93/time_stats ``` Example response: @@ -1429,7 +1429,7 @@ GET /projects/:id/issues/:issue_id/related_merge_requests | `issue_iid` | integer | yes | The internal ID of a project's issue | ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/1/issues/11/related_merge_requests +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/1/issues/11/related_merge_requests ``` Example response: @@ -1658,7 +1658,7 @@ GET /projects/:id/issues/:issue_iid/participants | `issue_iid` | integer | yes | The internal ID of a project's issue | ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/issues/93/participants +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/issues/93/participants ``` Example response: @@ -1702,7 +1702,7 @@ GET /projects/:id/issues/:issue_iid/user_agent_detail | `issue_iid` | integer | yes | The internal ID of a project's issue | ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/issues/93/user_agent_detail +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/issues/93/user_agent_detail ``` Example response: diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md index 981a8847926..54d140461e1 100644 --- a/doc/api/merge_requests.md +++ b/doc/api/merge_requests.md @@ -1632,7 +1632,7 @@ PUT /projects/:id/merge_requests/:merge_request_iid/rebase | `skip_ci` | boolean | no | Set to `true` to skip creating a CI pipeline | ```shell -curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/76/merge_requests/1/rebase +curl --request PUT --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/76/merge_requests/1/rebase ``` This is an asynchronous request. The API will return a `202 Accepted` response @@ -2410,7 +2410,7 @@ GET /projects/:id/merge_requests/:merge_request_iid/time_stats | `merge_request_iid` | integer | yes | The internal ID of the merge request | ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/merge_requests/93/time_stats +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/merge_requests/93/time_stats ``` Example response: diff --git a/doc/api/notes.md b/doc/api/notes.md index abf1be171c9..302b89e5359 100644 --- a/doc/api/notes.md +++ b/doc/api/notes.md @@ -80,7 +80,7 @@ GET /projects/:id/issues/:issue_iid/notes?sort=asc&order_by=updated_at ``` ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/issues/11/notes +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/issues/11/notes ``` ### Get single issue note @@ -98,7 +98,7 @@ Parameters: - `note_id` (required) - The ID of an issue note ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/issues/11/notes/1 +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/issues/11/notes/1 ``` ### Create new issue note @@ -178,7 +178,7 @@ GET /projects/:id/snippets/:snippet_id/notes?sort=asc&order_by=updated_at | `order_by` | string | no | Return snippet notes ordered by `created_at` or `updated_at` fields. Default is `created_at` ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/snippets/11/notes +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/snippets/11/notes ``` ### Get single snippet note @@ -215,7 +215,7 @@ Parameters: ``` ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/snippets/11/notes/11 +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/snippets/11/notes/11 ``` ### Create new snippet note @@ -296,7 +296,7 @@ GET /projects/:id/merge_requests/:merge_request_iid/notes?sort=asc&order_by=upda | `order_by` | string | no | Return merge request notes ordered by `created_at` or `updated_at` fields. Default is `created_at` ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/merge_requests/11/notes +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/merge_requests/11/notes ``` ### Get single merge request note @@ -337,7 +337,7 @@ Parameters: ``` ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/merge_requests/11/notes/1 +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/merge_requests/11/notes/1 ``` ### Create new merge request note @@ -415,7 +415,7 @@ GET /groups/:id/epics/:epic_id/notes?sort=asc&order_by=updated_at | `order_by` | string | no | Return epic notes ordered by `created_at` or `updated_at` fields. Default is `created_at` | ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/groups/5/epics/11/notes +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/groups/5/epics/11/notes ``` ### Get single epic note @@ -454,7 +454,7 @@ Parameters: ``` ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/groups/5/epics/11/notes/1 +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/groups/5/epics/11/notes/1 ``` ### Create new epic note diff --git a/doc/api/oauth2.md b/doc/api/oauth2.md index 9030feb13a7..c70ca1a74d5 100644 --- a/doc/api/oauth2.md +++ b/doc/api/oauth2.md @@ -102,7 +102,7 @@ CAUTION: **Important:** Avoid using this flow for applications that store data outside of the GitLab instance. If you do, make sure to verify `application id` associated with the access token before granting access to the data -(see [`/oauth/token/info`](https://github.com/doorkeeper-gem/doorkeeper/wiki/API-endpoint-descriptions-and-examples#get----oauthtokeninfo)). +(see [`/oauth/token/info`](#retrieving-the-token-info)). Unlike the web flow, the client receives an `access token` immediately as a result of the authorization request. The flow does not use the client secret @@ -212,3 +212,34 @@ or you can put the token to the Authorization header: ``` curl --header "Authorization: Bearer OAUTH-TOKEN" https://gitlab.example.com/api/v4/user ``` + +## Retrieving the Token Info + +To verify the details of a token you can call the `token/info` endpoint. This is provided from the doorkeeper gem (see [`/oauth/token/info`](https://github.com/doorkeeper-gem/doorkeeper/wiki/API-endpoint-descriptions-and-examples#get----oauthtokeninfo)). + +You will need to supply the access token, either as a parameter + +``` +GET https://gitlab.example.com/oauth/token/info?access_token=OAUTH-TOKEN +``` + +Or in the Authorization header: + +``` +curl --header "Authorization: Bearer OAUTH-TOKEN" https://gitlab.example.com/oauth/token/info +``` + +You will receive the following in response: + +```json +{ + "resource_owner_id": 1, + "scope": ["api"], + "expires_in": null, + "application": {"uid": "1cb242f495280beb4291e64bee2a17f330902e499882fe8e1e2aa875519cab33"}, + "created_at": 1575890427 +} +``` + +CAUTION: **Deprecated fields:** +The fields `scopes` and `expires_in_seconds` are also included in the response. They are aliases for `scope` and `expires_in` respectively and have been included to prevent breaking changes introduced in [doorkeeper 5.0.2](https://github.com/doorkeeper-gem/doorkeeper/wiki/Migration-from-old-versions#from-4x-to-5x). Please don't rely on these fields as they will be removed in a later release. diff --git a/doc/api/project_snippets.md b/doc/api/project_snippets.md index 3f40845fddc..ffdbd82adba 100644 --- a/doc/api/project_snippets.md +++ b/doc/api/project_snippets.md @@ -177,7 +177,7 @@ Parameters: Example request: ```shell -curl --request GET https://gitlab.com/api/v4/projects/:id/snippets/:snippet_id/raw \ +curl https://gitlab.com/api/v4/projects/:id/snippets/:snippet_id/raw \ --header "PRIVATE-TOKEN: " ``` @@ -199,7 +199,7 @@ GET /projects/:id/snippets/:snippet_id/user_agent_detail Example request: ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/1/snippets/2/user_agent_detail +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/1/snippets/2/user_agent_detail ``` Example response: diff --git a/doc/api/repository_files.md b/doc/api/repository_files.md index 33611af0fe2..c556f1e8108 100644 --- a/doc/api/repository_files.md +++ b/doc/api/repository_files.md @@ -25,7 +25,7 @@ GET /projects/:id/repository/files/:file_path ``` ```shell -curl --request GET --header 'PRIVATE-TOKEN: ' 'https://gitlab.example.com/api/v4/projects/13083/repository/files/app%2Fmodels%2Fkey%2Erb?ref=master' +curl --header 'PRIVATE-TOKEN: ' 'https://gitlab.example.com/api/v4/projects/13083/repository/files/app%2Fmodels%2Fkey%2Erb?ref=master' ``` Example response: @@ -89,7 +89,7 @@ GET /projects/:id/repository/files/:file_path/blame ``` ```shell -curl --request GET --header 'PRIVATE-TOKEN: ' 'https://gitlab.example.com/api/v4/projects/13083/repository/files/path%2Fto%2Ffile.rb/blame?ref=master' +curl --header 'PRIVATE-TOKEN: ' 'https://gitlab.example.com/api/v4/projects/13083/repository/files/path%2Fto%2Ffile.rb/blame?ref=master' ``` Example response: @@ -156,7 +156,7 @@ GET /projects/:id/repository/files/:file_path/raw ``` ```shell -curl --request GET --header 'PRIVATE-TOKEN: ' 'https://gitlab.example.com/api/v4/projects/13083/repository/files/app%2Fmodels%2Fkey%2Erb/raw?ref=master' +curl --header 'PRIVATE-TOKEN: ' 'https://gitlab.example.com/api/v4/projects/13083/repository/files/app%2Fmodels%2Fkey%2Erb/raw?ref=master' ``` Parameters: diff --git a/doc/api/resource_label_events.md b/doc/api/resource_label_events.md index 4753b2e3c90..6532e2d4231 100644 --- a/doc/api/resource_label_events.md +++ b/doc/api/resource_label_events.md @@ -65,7 +65,7 @@ GET /projects/:id/issues/:issue_iid/resource_label_events ``` ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/issues/11/resource_label_events +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/issues/11/resource_label_events ``` ### Get single issue label event @@ -85,7 +85,7 @@ Parameters: | `resource_label_event_id` | integer | yes | The ID of a label event | ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/issues/11/resource_label_events/1 +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/issues/11/resource_label_events/1 ``` ## Epics **(ULTIMATE)** @@ -151,7 +151,7 @@ GET /groups/:id/epics/:epic_id/resource_label_events ``` ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/groups/1/epics/11/resource_label_events +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/groups/1/epics/11/resource_label_events ``` ### Get single epic label event @@ -237,7 +237,7 @@ GET /projects/:id/merge_requests/:merge_request_iid/resource_label_events ``` ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/merge_requests/11/resource_label_events +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/5/merge_requests/11/resource_label_events ``` ### Get single merge request label event diff --git a/doc/api/search.md b/doc/api/search.md index bac259651f8..8203fbecbb3 100644 --- a/doc/api/search.md +++ b/doc/api/search.md @@ -26,7 +26,7 @@ The response depends on the requested scope. ### Scope: projects ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/search?scope=projects&search=flight +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/search?scope=projects&search=flight ``` Example response: @@ -57,7 +57,7 @@ Example response: ### Scope: issues ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/search?scope=issues&search=file +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/search?scope=issues&search=file ``` Example response: @@ -122,7 +122,7 @@ Example response: ### Scope: merge_requests ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/search?scope=merge_requests&search=file +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/search?scope=merge_requests&search=file ``` Example response: @@ -200,7 +200,7 @@ Example response: ### Scope: milestones ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/search?scope=milestones&search=release +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/search?scope=milestones&search=release ``` Example response: @@ -225,7 +225,7 @@ Example response: ### Scope: snippet_titles ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/search?scope=snippet_titles&search=sample +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/search?scope=snippet_titles&search=sample ``` Example response: @@ -256,7 +256,7 @@ Example response: ### Scope: snippet_blobs ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/search?scope=snippet_blobs&search=test +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/search?scope=snippet_blobs&search=test ``` Example response: @@ -289,7 +289,7 @@ Example response: This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled. ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/search?scope=wiki_blobs&search=bye +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/search?scope=wiki_blobs&search=bye ``` Example response: @@ -317,7 +317,7 @@ Example response: This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled. ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/search?scope=commits&search=bye +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/search?scope=commits&search=bye ``` Example response: @@ -360,7 +360,7 @@ to use a filter simply include it in your query like so: `a query filename:some_ You may use wildcards (`*`) to use glob matching. ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/search?scope=blobs&search=installation +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/search?scope=blobs&search=installation ``` Example response: @@ -386,7 +386,7 @@ Example response: ### Scope: users ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/search?scope=users&search=doe +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/search?scope=users&search=doe ``` Example response: @@ -429,7 +429,7 @@ The response depends on the requested scope. ### Scope: projects ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/groups/3/search?scope=projects&search=flight +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/groups/3/search?scope=projects&search=flight ``` Example response: @@ -460,7 +460,7 @@ Example response: ### Scope: issues ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/groups/3/search?scope=issues&search=file +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/groups/3/search?scope=issues&search=file ``` Example response: @@ -525,7 +525,7 @@ Example response: ### Scope: merge_requests ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/groups/3/search?scope=merge_requests&search=file +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/groups/3/search?scope=merge_requests&search=file ``` Example response: @@ -603,7 +603,7 @@ Example response: ### Scope: milestones ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/groups/3/search?scope=milestones&search=release +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/groups/3/search?scope=milestones&search=release ``` Example response: @@ -630,7 +630,7 @@ Example response: This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled. ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/groups/6/search?scope=wiki_blobs&search=bye +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/groups/6/search?scope=wiki_blobs&search=bye ``` Example response: @@ -658,7 +658,7 @@ Example response: This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled. ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/groups/6/search?scope=commits&search=bye +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/groups/6/search?scope=commits&search=bye ``` Example response: @@ -701,7 +701,7 @@ to use a filter simply include it in your query like so: `a query filename:some_ You may use wildcards (`*`) to use glob matching. ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/groups/6/search?scope=blobs&search=installation +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/groups/6/search?scope=blobs&search=installation ``` Example response: @@ -727,7 +727,7 @@ Example response: ### Scope: users ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/groups/3/search?scope=users&search=doe +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/groups/3/search?scope=users&search=doe ``` Example response: @@ -769,7 +769,7 @@ The response depends on the requested scope. ### Scope: issues ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/12/search?scope=issues&search=file +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/12/search?scope=issues&search=file ``` Example response: @@ -834,7 +834,7 @@ Example response: ### Scope: merge_requests ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/6/search?scope=merge_requests&search=file +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/6/search?scope=merge_requests&search=file ``` Example response: @@ -912,7 +912,7 @@ Example response: ### Scope: milestones ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/12/search?scope=milestones&search=release +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/12/search?scope=milestones&search=release ``` Example response: @@ -937,7 +937,7 @@ Example response: ### Scope: notes ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/6/search?scope=notes&search=maxime +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/6/search?scope=notes&search=maxime ``` Example response: @@ -986,7 +986,7 @@ results: times in the content. ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/6/search?scope=wiki_blobs&search=bye +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/6/search?scope=wiki_blobs&search=bye ``` Example response: @@ -1012,7 +1012,7 @@ Example response: ### Scope: commits ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/6/search?scope=commits&search=bye +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/6/search?scope=commits&search=bye ``` Example response: @@ -1059,7 +1059,7 @@ Blobs searches are performed on both filenames and contents. Search results: times in the content. ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/6/search?scope=blobs&search=installation&ref=feature +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/6/search?scope=blobs&search=installation&ref=feature ``` Example response: @@ -1085,7 +1085,7 @@ Example response: ### Scope: users ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/6/search?scope=users&search=doe +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/projects/6/search?scope=users&search=doe ``` Example response: diff --git a/doc/api/snippets.md b/doc/api/snippets.md index 5c24cc60eca..0b41ab557ad 100644 --- a/doc/api/snippets.md +++ b/doc/api/snippets.md @@ -367,7 +367,7 @@ GET /snippets/:id/user_agent_detail Example request: ```shell -curl --request GET --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/snippets/1/user_agent_detail +curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/snippets/1/user_agent_detail ``` Example response: diff --git a/doc/ci/ci_cd_for_external_repos/bitbucket_integration.md b/doc/ci/ci_cd_for_external_repos/bitbucket_integration.md index e013078fa2e..9aed5020f2b 100644 --- a/doc/ci/ci_cd_for_external_repos/bitbucket_integration.md +++ b/doc/ci/ci_cd_for_external_repos/bitbucket_integration.md @@ -30,7 +30,7 @@ To use GitLab CI/CD with a Bitbucket Cloud repository: using the Personal Access Token we just generated for authentication. ```text - https://gitlab.com/api/v4/projects/%2F/mirror/pull?private_token= + https://gitlab.com/api/v4/projects//mirror/pull?private_token= ``` The web hook Trigger should be set to 'Repository Push'. diff --git a/doc/ci/triggers/README.md b/doc/ci/triggers/README.md index 414b0279c47..aa03add0ac2 100644 --- a/doc/ci/triggers/README.md +++ b/doc/ci/triggers/README.md @@ -249,6 +249,9 @@ curl --request POST \ https://gitlab.example.com/api/v4/projects/9/trigger/pipeline ``` +Trigger variables have the [highest priority](../variables/README.md#priority-of-environment-variables) +of all types of variables. + ## Using cron to trigger nightly pipelines >**Note:** diff --git a/doc/user/project/issues/img/related_issue_block_v12_8.png b/doc/user/project/issues/img/related_issue_block_v12_8.png new file mode 100644 index 00000000000..02d70868abc Binary files /dev/null and b/doc/user/project/issues/img/related_issue_block_v12_8.png differ diff --git a/doc/user/project/issues/img/related_issues_add.png b/doc/user/project/issues/img/related_issues_add.png deleted file mode 100644 index f59d2335386..00000000000 Binary files a/doc/user/project/issues/img/related_issues_add.png and /dev/null differ diff --git a/doc/user/project/issues/img/related_issues_add_v12_8.png b/doc/user/project/issues/img/related_issues_add_v12_8.png new file mode 100644 index 00000000000..5d6fa218426 Binary files /dev/null and b/doc/user/project/issues/img/related_issues_add_v12_8.png differ diff --git a/doc/user/project/issues/img/related_issues_remove.png b/doc/user/project/issues/img/related_issues_remove.png deleted file mode 100644 index be2ec59e61b..00000000000 Binary files a/doc/user/project/issues/img/related_issues_remove.png and /dev/null differ diff --git a/doc/user/project/issues/img/related_issues_remove_v12_8.png b/doc/user/project/issues/img/related_issues_remove_v12_8.png new file mode 100644 index 00000000000..bf35bec1bec Binary files /dev/null and b/doc/user/project/issues/img/related_issues_remove_v12_8.png differ diff --git a/doc/user/project/issues/related_issues.md b/doc/user/project/issues/related_issues.md index bedb273ea76..5fba73c2971 100644 --- a/doc/user/project/issues/related_issues.md +++ b/doc/user/project/issues/related_issues.md @@ -14,6 +14,12 @@ You can relate one issue to another by clicking the related issues "+" button in the header of the related issue block. Then, input the issue reference number or paste in the full URL of the issue. +> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/2035) in GitLab 12.8. + +Additionally, you can select whether the current issue relates to, blocks, or is blocked by the issues being entered. + +![Adding a related issue](img/related_issues_add_v12_8.png) + Issues of the same project can be specified just by the reference number. Issues from a different project require additional information like the group and the project name. For example: @@ -23,9 +29,12 @@ group and the project name. For example: - different group: `group/project#44` Valid references will be added to a temporary list that you can review. -When ready, click the green "Add related issues" button to submit. +When you have added all the related issues, click **Add** to submit. + +Once you have finished adding all related issues, you will be able to see +them categorized so their relationships can be better understood visually. -![Adding a related issue](img/related_issues_add.png) +![Related issue block](img/related_issue_block_v12_8.png) ## Removing a related issue @@ -33,7 +42,7 @@ In the related issues block, click the "x" icon on the right-side of each issue token that you wish to remove. Due to the bi-directional relationship, it will no longer appear in either issue. -![Removing a related issue](img/related_issues_remove.png) +![Removing a related issue](img/related_issues_remove_v12_8.png) Please access our [permissions](../../permissions.md) page for more information. -- cgit v1.2.3