diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-02-28 12:09:05 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-02-28 12:09:05 +0000 |
commit | 5426ca9908085087d465fa52800335f408eb965a (patch) | |
tree | 6b442cff02fda9402fc7bb9cf9986e363dd5aaa6 /doc/api | |
parent | 67cdfd2683b89bce260600fa8925eefdcdf9e3e5 (diff) | |
download | gitlab-ce-5426ca9908085087d465fa52800335f408eb965a.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/deploy_tokens.md | 51 | ||||
-rw-r--r-- | doc/api/graphql/reference/gitlab_schema.graphql | 6 | ||||
-rw-r--r-- | doc/api/graphql/reference/gitlab_schema.json | 36 |
3 files changed, 66 insertions, 27 deletions
diff --git a/doc/api/deploy_tokens.md b/doc/api/deploy_tokens.md index 501e5c4be36..ed05f46dae0 100644 --- a/doc/api/deploy_tokens.md +++ b/doc/api/deploy_tokens.md @@ -2,15 +2,14 @@ ## List all deploy tokens -Get a list of all deploy tokens across all projects of the GitLab instance. +Get a list of all deploy tokens across the GitLab instance. This endpoint requires admin access. ->**Note:** -> This endpoint requires admin access. - -``` +```plaintext GET /deploy_tokens ``` +Example request: + ```shell curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/deploy_tokens" ``` @@ -24,7 +23,47 @@ Example response: "name": "MyToken", "username": "gitlab+deploy-token-1", "expires_at": "2020-02-14T00:00:00.000Z", - "token": "jMRvtPNxrn3crTAGukpZ", + "scopes": [ + "read_repository", + "read_registry" + ] + } +] +``` + +## Project deploy tokens + +Project deploy token API endpoints require project maintainer access or higher. + +### List project deploy tokens + +Get a list of a project's deploy tokens. + +```plaintext +GET /projects/:id/deploy_tokens +``` + +Parameters: + +| Attribute | Type | Required | Description | +|:---------------|:---------------|:---------|:-----------------------------------------------------------------------------| +| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). | + +Example request: + +```shell +curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/deploy_tokens" +``` + +Example response: + +```json +[ + { + "id": 1, + "name": "MyToken", + "username": "gitlab+deploy-token-1", + "expires_at": "2020-02-14T00:00:00.000Z", "scopes": [ "read_repository", "read_registry" diff --git a/doc/api/graphql/reference/gitlab_schema.graphql b/doc/api/graphql/reference/gitlab_schema.graphql index 6b62b11750c..8d6fc859ca2 100644 --- a/doc/api/graphql/reference/gitlab_schema.graphql +++ b/doc/api/graphql/reference/gitlab_schema.graphql @@ -2609,12 +2609,12 @@ input EpicSetSubscriptionInput { clientMutationId: String """ - The group the epic to (un)subscribe is in + The group the epic to mutate is in """ groupPath: ID! """ - The iid of the epic to (un)subscribe + The iid of the epic to mutate """ iid: ID! @@ -7820,7 +7820,7 @@ input UpdateEpicInput { """ The iid of the epic to mutate """ - iid: String! + iid: ID! """ The IDs of labels to be removed from the epic. diff --git a/doc/api/graphql/reference/gitlab_schema.json b/doc/api/graphql/reference/gitlab_schema.json index ba716f82630..4f2cbe81781 100644 --- a/doc/api/graphql/reference/gitlab_schema.json +++ b/doc/api/graphql/reference/gitlab_schema.json @@ -24410,6 +24410,20 @@ "fields": null, "inputFields": [ { + "name": "iid", + "description": "The iid of the epic to mutate", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { "name": "groupPath", "description": "The group the epic to mutate is in", "type": { @@ -24520,20 +24534,6 @@ "defaultValue": null }, { - "name": "iid", - "description": "The iid of the epic to mutate", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { "name": "stateEvent", "description": "State event for the epic", "type": { @@ -24863,8 +24863,8 @@ "fields": null, "inputFields": [ { - "name": "groupPath", - "description": "The group the epic to (un)subscribe is in", + "name": "iid", + "description": "The iid of the epic to mutate", "type": { "kind": "NON_NULL", "name": null, @@ -24877,8 +24877,8 @@ "defaultValue": null }, { - "name": "iid", - "description": "The iid of the epic to (un)subscribe", + "name": "groupPath", + "description": "The group the epic to mutate is in", "type": { "kind": "NON_NULL", "name": null, |