diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-17 15:09:10 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-17 15:09:10 +0000 |
commit | 8e129497b2565b8c595ef4f806d9a9595ca654e5 (patch) | |
tree | 7afeeca3ea58013c1e8c3a2055661bacf65577da /doc/api | |
parent | 8ae26d705abe341b03bc15d4373d6cd0c77c0baf (diff) | |
download | gitlab-ce-8e129497b2565b8c595ef4f806d9a9595ca654e5.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/graphql/reference/gitlab_schema.graphql | 129 | ||||
-rw-r--r-- | doc/api/graphql/reference/gitlab_schema.json | 440 | ||||
-rw-r--r-- | doc/api/graphql/reference/index.md | 38 |
3 files changed, 607 insertions, 0 deletions
diff --git a/doc/api/graphql/reference/gitlab_schema.graphql b/doc/api/graphql/reference/gitlab_schema.graphql index f3c06a917a7..86942c489b3 100644 --- a/doc/api/graphql/reference/gitlab_schema.graphql +++ b/doc/api/graphql/reference/gitlab_schema.graphql @@ -602,6 +602,46 @@ type CreateNotePayload { } """ +Autogenerated input type of CreateRequirement +""" +input CreateRequirementInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The project full path the requirement is associated with + """ + projectPath: ID! + + """ + Title of the requirement + """ + title: String! +} + +""" +Autogenerated return type of CreateRequirement +""" +type CreateRequirementPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + Reasons why the mutation failed. + """ + errors: [String!]! + + """ + The requirement after mutation + """ + requirement: Requirement +} + +""" Autogenerated input type of CreateSnippet """ input CreateSnippetInput { @@ -4952,6 +4992,7 @@ type Mutation { createEpic(input: CreateEpicInput!): CreateEpicPayload createImageDiffNote(input: CreateImageDiffNoteInput!): CreateImageDiffNotePayload createNote(input: CreateNoteInput!): CreateNotePayload + createRequirement(input: CreateRequirementInput!): CreateRequirementPayload createSnippet(input: CreateSnippetInput!): CreateSnippetPayload designManagementDelete(input: DesignManagementDeleteInput!): DesignManagementDeletePayload designManagementUpload(input: DesignManagementUploadInput!): DesignManagementUploadPayload @@ -6574,6 +6615,94 @@ type Repository { ): Tree } +""" +Represents a requirement. +""" +type Requirement { + """ + Author of the requirement + """ + author: User! + + """ + Timestamp of when the requirement was created + """ + createdAt: Time! + + """ + ID of the requirement + """ + id: ID! + + """ + Internal ID of the requirement + """ + iid: ID! + + """ + Project to which the requirement belongs + """ + project: Project! + + """ + State of the requirement + """ + state: RequirementState! + + """ + Title of the requirement + """ + title: String + + """ + Timestamp of when the requirement was last updated + """ + updatedAt: Time! + + """ + Permissions for the current user on the resource + """ + userPermissions: RequirementPermissions! +} + +""" +Check permissions for the current user on a requirement +""" +type RequirementPermissions { + """ + Indicates the user can perform `admin_requirement` on this resource + """ + adminRequirement: Boolean! + + """ + Indicates the user can perform `create_requirement` on this resource + """ + createRequirement: Boolean! + + """ + Indicates the user can perform `destroy_requirement` on this resource + """ + destroyRequirement: Boolean! + + """ + Indicates the user can perform `read_requirement` on this resource + """ + readRequirement: Boolean! + + """ + Indicates the user can perform `update_requirement` on this resource + """ + updateRequirement: Boolean! +} + +""" +State of a requirement +""" +enum RequirementState { + ARCHIVED + OPENED +} + type RootStorageStatistics { """ The CI artifacts size in bytes diff --git a/doc/api/graphql/reference/gitlab_schema.json b/doc/api/graphql/reference/gitlab_schema.json index 65ff33c923c..d618ca38772 100644 --- a/doc/api/graphql/reference/gitlab_schema.json +++ b/doc/api/graphql/reference/gitlab_schema.json @@ -1764,6 +1764,122 @@ }, { "kind": "INPUT_OBJECT", + "name": "CreateRequirementInput", + "description": "Autogenerated input type of CreateRequirement", + "fields": null, + "inputFields": [ + { + "name": "title", + "description": "Title of the requirement", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "projectPath", + "description": "The project full path the requirement is associated with", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "clientMutationId", + "description": "A unique identifier for the client performing the mutation.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CreateRequirementPayload", + "description": "Autogenerated return type of CreateRequirement", + "fields": [ + { + "name": "clientMutationId", + "description": "A unique identifier for the client performing the mutation.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "errors", + "description": "Reasons why the mutation failed.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requirement", + "description": "The requirement after mutation", + "args": [ + + ], + "type": { + "kind": "OBJECT", + "name": "Requirement", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", "name": "CreateSnippetInput", "description": "Autogenerated input type of CreateSnippet", "fields": null, @@ -14391,6 +14507,33 @@ "deprecationReason": null }, { + "name": "createRequirement", + "description": null, + "args": [ + { + "name": "input", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CreateRequirementInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CreateRequirementPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "createSnippet", "description": null, "args": [ @@ -19794,6 +19937,303 @@ }, { "kind": "OBJECT", + "name": "Requirement", + "description": "Represents a requirement.", + "fields": [ + { + "name": "author", + "description": "Author of the requirement", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "User", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "Timestamp of when the requirement was created", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Time", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "ID of the requirement", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "iid", + "description": "Internal ID of the requirement", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "project", + "description": "Project to which the requirement belongs", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Project", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "state", + "description": "State of the requirement", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "RequirementState", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "Title of the requirement", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "Timestamp of when the requirement was last updated", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Time", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userPermissions", + "description": "Permissions for the current user on the resource", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "RequirementPermissions", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RequirementPermissions", + "description": "Check permissions for the current user on a requirement", + "fields": [ + { + "name": "adminRequirement", + "description": "Indicates the user can perform `admin_requirement` on this resource", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createRequirement", + "description": "Indicates the user can perform `create_requirement` on this resource", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "destroyRequirement", + "description": "Indicates the user can perform `destroy_requirement` on this resource", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "readRequirement", + "description": "Indicates the user can perform `read_requirement` on this resource", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updateRequirement", + "description": "Indicates the user can perform `update_requirement` on this resource", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "RequirementState", + "description": "State of a requirement", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "OPENED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ARCHIVED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", "name": "RootStorageStatistics", "description": null, "fields": [ diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index 6d78f897017..5d603714674 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -129,6 +129,16 @@ Autogenerated return type of CreateNote | `errors` | String! => Array | Reasons why the mutation failed. | | `note` | Note | The note after mutation | +## CreateRequirementPayload + +Autogenerated return type of CreateRequirement + +| Name | Type | Description | +| --- | ---- | ---------- | +| `clientMutationId` | String | A unique identifier for the client performing the mutation. | +| `errors` | String! => Array | Reasons why the mutation failed. | +| `requirement` | Requirement | The requirement after mutation | + ## CreateSnippetPayload Autogenerated return type of CreateSnippet @@ -982,6 +992,34 @@ Autogenerated return type of RemoveAwardEmoji | `rootRef` | String | Default branch of the repository | | `tree` | Tree | Tree of the repository | +## Requirement + +Represents a requirement. + +| Name | Type | Description | +| --- | ---- | ---------- | +| `author` | User! | Author of the requirement | +| `createdAt` | Time! | Timestamp of when the requirement was created | +| `id` | ID! | ID of the requirement | +| `iid` | ID! | Internal ID of the requirement | +| `project` | Project! | Project to which the requirement belongs | +| `state` | RequirementState! | State of the requirement | +| `title` | String | Title of the requirement | +| `updatedAt` | Time! | Timestamp of when the requirement was last updated | +| `userPermissions` | RequirementPermissions! | Permissions for the current user on the resource | + +## RequirementPermissions + +Check permissions for the current user on a requirement + +| Name | Type | Description | +| --- | ---- | ---------- | +| `adminRequirement` | Boolean! | Indicates the user can perform `admin_requirement` on this resource | +| `createRequirement` | Boolean! | Indicates the user can perform `create_requirement` on this resource | +| `destroyRequirement` | Boolean! | Indicates the user can perform `destroy_requirement` on this resource | +| `readRequirement` | Boolean! | Indicates the user can perform `read_requirement` on this resource | +| `updateRequirement` | Boolean! | Indicates the user can perform `update_requirement` on this resource | + ## RootStorageStatistics | Name | Type | Description | |