diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-17 18:09:10 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-17 18:09:10 +0300 |
commit | 8e129497b2565b8c595ef4f806d9a9595ca654e5 (patch) | |
tree | 7afeeca3ea58013c1e8c3a2055661bacf65577da /doc/api/graphql/reference/index.md | |
parent | 8ae26d705abe341b03bc15d4373d6cd0c77c0baf (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api/graphql/reference/index.md')
-rw-r--r-- | doc/api/graphql/reference/index.md | 38 |
1 files changed, 38 insertions, 0 deletions
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 | |