diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-04-08 06:09:54 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-04-08 06:09:54 +0000 |
commit | f6cdec670b9b757fc2225a2c6627ab79765e5b8a (patch) | |
tree | 7a1fde030f117b69332d01b22deefd1c81fff458 /doc/api | |
parent | e2ee1eec50aa8df8543d7ecc585ec0ba5ee544ac (diff) | |
download | gitlab-ce-f6cdec670b9b757fc2225a2c6627ab79765e5b8a.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/deploy_tokens.md | 2 | ||||
-rw-r--r-- | doc/api/discussions.md | 2 | ||||
-rw-r--r-- | doc/api/epic_links.md | 2 | ||||
-rw-r--r-- | doc/api/graphql/index.md | 2 | ||||
-rw-r--r-- | doc/api/graphql/reference/gitlab_schema.graphql | 143 | ||||
-rw-r--r-- | doc/api/graphql/reference/gitlab_schema.json | 540 | ||||
-rw-r--r-- | doc/api/graphql/reference/index.md | 14 | ||||
-rw-r--r-- | doc/api/releases/links.md | 2 | ||||
-rw-r--r-- | doc/api/runners.md | 8 |
9 files changed, 706 insertions, 9 deletions
diff --git a/doc/api/deploy_tokens.md b/doc/api/deploy_tokens.md index 4d62fc857ba..4663159f1eb 100644 --- a/doc/api/deploy_tokens.md +++ b/doc/api/deploy_tokens.md @@ -138,7 +138,7 @@ curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://git These endpoints require group maintainer access or higher. -### List group deploy deploy tokens +### List group deploy tokens > [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/21811) in GitLab 12.9. diff --git a/doc/api/discussions.md b/doc/api/discussions.md index 936fcae0b72..f1e8965b336 100644 --- a/doc/api/discussions.md +++ b/doc/api/discussions.md @@ -552,7 +552,7 @@ curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab ### Create new epic thread Creates a new thread to a single group epic. This is similar to creating -a note but but other comments (replies) can be added to it later. +a note but other comments (replies) can be added to it later. ```plaintext POST /groups/:id/epics/:epic_id/discussions diff --git a/doc/api/epic_links.md b/doc/api/epic_links.md index 5df91e106eb..36503942729 100644 --- a/doc/api/epic_links.md +++ b/doc/api/epic_links.md @@ -120,7 +120,7 @@ Example response: ## Create and assign a child epic -Creates a a new epic and associates it with provided parent epic. The response is LinkedEpic object. +Creates a new epic and associates it with provided parent epic. The response is LinkedEpic object. ```plaintext POST /groups/:id/epics/:epic_iid/epics diff --git a/doc/api/graphql/index.md b/doc/api/graphql/index.md index dc691185d28..044c3500bf4 100644 --- a/doc/api/graphql/index.md +++ b/doc/api/graphql/index.md @@ -73,7 +73,7 @@ Root-level queries are defined in GitLab supports batching queries into a single request using [apollo-link-batch-http](https://www.apollographql.com/docs/link/links/batch-http/). More information about multiplexed queries is also available for -[graphql-ruby](https://graphql-ruby.org/queries/multiplex.html) the +[GraphQL Ruby](https://graphql-ruby.org/queries/multiplex.html), the library GitLab uses on the backend. ## Reference diff --git a/doc/api/graphql/reference/gitlab_schema.graphql b/doc/api/graphql/reference/gitlab_schema.graphql index 2696c7355bc..7e863490369 100644 --- a/doc/api/graphql/reference/gitlab_schema.graphql +++ b/doc/api/graphql/reference/gitlab_schema.graphql @@ -138,6 +138,18 @@ type AwardEmoji { user: User! } +type BaseService implements Service { + """ + Indicates if the service is active + """ + active: Boolean + + """ + Class name of the service + """ + type: String +} + type Blob implements Entry { """ Flat path of the entry @@ -4246,6 +4258,18 @@ type JiraImportStartPayload { jiraImport: JiraImport } +type JiraService implements Service { + """ + Indicates if the service is active + """ + active: Boolean + + """ + Class name of the service + """ + type: String +} + type Label { """ Background color of the label @@ -6411,6 +6435,41 @@ type Project { serviceDeskEnabled: Boolean """ + Project services + """ + services( + """ + Indicates if the service is active + """ + active: Boolean + + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + + """ + Class name of the service + """ + type: ServiceType + ): ServiceConnection + + """ Indicates if Shared Runners are enabled for the project """ sharedRunnersEnabled: Boolean @@ -7637,6 +7696,90 @@ type SentryErrorTags { logger: String } +interface Service { + """ + Indicates if the service is active + """ + active: Boolean + + """ + Class name of the service + """ + type: String +} + +""" +The connection type for Service. +""" +type ServiceConnection { + """ + A list of edges. + """ + edges: [ServiceEdge] + + """ + A list of nodes. + """ + nodes: [Service] + + """ + Information to aid in pagination. + """ + pageInfo: PageInfo! +} + +""" +An edge in a connection. +""" +type ServiceEdge { + """ + A cursor for use in pagination. + """ + cursor: String! + + """ + The item at the end of the edge. + """ + node: Service +} + +enum ServiceType { + ALERTS_SERVICE + ASANA_SERVICE + ASSEMBLA_SERVICE + BAMBOO_SERVICE + BUGZILLA_SERVICE + BUILDKITE_SERVICE + CAMPFIRE_SERVICE + CUSTOM_ISSUE_TRACKER_SERVICE + DISCORD_SERVICE + DRONE_CI_SERVICE + EMAILS_ON_PUSH_SERVICE + EXTERNAL_WIKI_SERVICE + FLOWDOCK_SERVICE + GITHUB_SERVICE + HANGOUTS_CHAT_SERVICE + HIPCHAT_SERVICE + IRKER_SERVICE + JENKINS_DEPRECATED_SERVICE + JENKINS_SERVICE + JIRA_SERVICE + MATTERMOST_SERVICE + MATTERMOST_SLASH_COMMANDS_SERVICE + MICROSOFT_TEAMS_SERVICE + PACKAGIST_SERVICE + PIPELINES_EMAIL_SERVICE + PIVOTALTRACKER_SERVICE + PROMETHEUS_SERVICE + PUSHOVER_SERVICE + REDMINE_SERVICE + SLACK_SERVICE + SLACK_SLASH_COMMANDS_SERVICE + TEAMCITY_SERVICE + UNIFY_CIRCUIT_SERVICE + YOUTRACK_SERVICE +} + """ Represents a snippet entry """ diff --git a/doc/api/graphql/reference/gitlab_schema.json b/doc/api/graphql/reference/gitlab_schema.json index 66f4ce0940f..813ab39795a 100644 --- a/doc/api/graphql/reference/gitlab_schema.json +++ b/doc/api/graphql/reference/gitlab_schema.json @@ -410,6 +410,51 @@ }, { "kind": "OBJECT", + "name": "BaseService", + "description": null, + "fields": [ + { + "name": "active", + "description": "Indicates if the service is active", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "Class name of the service", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Service", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", "name": "Blob", "description": null, "fields": [ @@ -12063,6 +12108,51 @@ }, { "kind": "OBJECT", + "name": "JiraService", + "description": null, + "fields": [ + { + "name": "active", + "description": "Indicates if the service is active", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "Class name of the service", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Service", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", "name": "Label", "description": null, "fields": [ @@ -19142,6 +19232,79 @@ "deprecationReason": null }, { + "name": "services", + "description": "Project services", + "args": [ + { + "name": "active", + "description": "Indicates if the service is active", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "type", + "description": "Class name of the service", + "type": { + "kind": "ENUM", + "name": "ServiceType", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements in the list that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements in the list that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns the first _n_ elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns the last _n_ elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ServiceConnection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "sharedRunnersEnabled", "description": "Indicates if Shared Runners are enabled for the project", "args": [ @@ -23019,6 +23182,383 @@ "possibleTypes": null }, { + "kind": "INTERFACE", + "name": "Service", + "description": null, + "fields": [ + { + "name": "active", + "description": "Indicates if the service is active", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "Class name of the service", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "BaseService", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "JiraService", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "ServiceConnection", + "description": "The connection type for Service.", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [ + + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ServiceEdge", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of nodes.", + "args": [ + + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "Service", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ServiceEdge", + "description": "An edge in a connection.", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of the edge.", + "args": [ + + ], + "type": { + "kind": "INTERFACE", + "name": "Service", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ServiceType", + "description": null, + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ALERTS_SERVICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ASANA_SERVICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ASSEMBLA_SERVICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BAMBOO_SERVICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BUGZILLA_SERVICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BUILDKITE_SERVICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CAMPFIRE_SERVICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOM_ISSUE_TRACKER_SERVICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISCORD_SERVICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DRONE_CI_SERVICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EMAILS_ON_PUSH_SERVICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXTERNAL_WIKI_SERVICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FLOWDOCK_SERVICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HANGOUTS_CHAT_SERVICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HIPCHAT_SERVICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IRKER_SERVICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JIRA_SERVICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MATTERMOST_SERVICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MATTERMOST_SLASH_COMMANDS_SERVICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MICROSOFT_TEAMS_SERVICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PACKAGIST_SERVICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PIPELINES_EMAIL_SERVICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PIVOTALTRACKER_SERVICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PROMETHEUS_SERVICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PUSHOVER_SERVICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REDMINE_SERVICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SLACK_SERVICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SLACK_SLASH_COMMANDS_SERVICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TEAMCITY_SERVICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNIFY_CIRCUIT_SERVICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "YOUTRACK_SERVICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GITHUB_SERVICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JENKINS_SERVICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JENKINS_DEPRECATED_SERVICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { "kind": "OBJECT", "name": "Snippet", "description": "Represents a snippet entry", diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index d1ddcb6435b..dbe98639d23 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -49,6 +49,13 @@ An emoji awarded by a user. | `unicodeVersion` | String! | The unicode version for this emoji | | `user` | User! | The user who awarded the emoji | +## BaseService + +| Name | Type | Description | +| --- | ---- | ---------- | +| `active` | Boolean | Indicates if the service is active | +| `type` | String | Class name of the service | + ## Blob | Name | Type | Description | @@ -624,6 +631,13 @@ Autogenerated return type of JiraImportStart | `errors` | String! => Array | Reasons why the mutation failed. | | `jiraImport` | JiraImport | The Jira import data after mutation | +## JiraService + +| Name | Type | Description | +| --- | ---- | ---------- | +| `active` | Boolean | Indicates if the service is active | +| `type` | String | Class name of the service | + ## Label | Name | Type | Description | diff --git a/doc/api/releases/links.md b/doc/api/releases/links.md index ed428b0fe75..bf882ef35c0 100644 --- a/doc/api/releases/links.md +++ b/doc/api/releases/links.md @@ -3,7 +3,7 @@ > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/issues/41766) in GitLab 11.7. Using this API you can manipulate GitLab's [Release](../../user/project/releases/index.md) links. For manipulating other Release assets, see [Release API](index.md). -GitLab supports links links to `http`, `https`, and `ftp` assets. +GitLab supports links to `http`, `https`, and `ftp` assets. ## Get links diff --git a/doc/api/runners.md b/doc/api/runners.md index c17069b4474..523f0363cee 100644 --- a/doc/api/runners.md +++ b/doc/api/runners.md @@ -42,7 +42,7 @@ GET /runners?tag_list=tag1,tag2 | `scope` | string | no | Deprecated: Use `type` or `status` instead. The scope of specific runners to show, one of: `active`, `paused`, `online`, `offline`; showing all runners if none provided | | `type` | string | no | The type of runners to show, one of: `instance_type`, `group_type`, `project_type` | | `status` | string | no | The status of runners to show, one of: `active`, `paused`, `online`, `offline` | -| `tag_list` | string array | no | List of of the runner's tags | +| `tag_list` | string array | no | List of the runner's tags | ```shell curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/runners" @@ -93,7 +93,7 @@ GET /runners/all?tag_list=tag1,tag2 | `scope` | string | no | Deprecated: Use `type` or `status` instead. The scope of runners to show, one of: `specific`, `shared`, `active`, `paused`, `online`, `offline`; showing all runners if none provided | | `type` | string | no | The type of runners to show, one of: `instance_type`, `group_type`, `project_type` | | `status` | string | no | The status of runners to show, one of: `active`, `paused`, `online`, `offline` | -| `tag_list` | string array | no | List of of the runner's tags | +| `tag_list` | string array | no | List of the runner's tags | ```shell curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/runners/all" @@ -385,7 +385,7 @@ GET /projects/:id/runners?tag_list=tag1,tag2 | `scope` | string | no | Deprecated: Use `type` or `status` instead. The scope of specific runners to show, one of: `active`, `paused`, `online`, `offline`; showing all runners if none provided | | `type` | string | no | The type of runners to show, one of: `instance_type`, `group_type`, `project_type` | | `status` | string | no | The status of runners to show, one of: `active`, `paused`, `online`, `offline` | -| `tag_list` | string array | no | List of of the runner's tags | +| `tag_list` | string array | no | List of the runner's tags | ```shell curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/9/runners" @@ -486,7 +486,7 @@ GET /groups/:id/runners?tag_list=tag1,tag2 | `id` | integer | yes | The ID of the group owned by the authenticated user | | `type` | string | no | The type of runners to show, one of: `instance_type`, `group_type`, `project_type` | | `status` | string | no | The status of runners to show, one of: `active`, `paused`, `online`, `offline` | -| `tag_list` | string array | no | List of of the runner's tags | +| `tag_list` | string array | no | List of the runner's tags | ```shell curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/9/runners" |