diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2019-12-09 00:07:44 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2019-12-09 00:07:44 +0000 |
commit | 3359a5a56337b93cd34b9914b6468395bfb6c514 (patch) | |
tree | b4a01c84a076934d942858b36d2a8e016256efb4 /doc | |
parent | f7c17a066a65bef78e2c2c9f4b70cb5ad86007b0 (diff) | |
download | gitlab-ce-3359a5a56337b93cd34b9914b6468395bfb6c514.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/graphql/reference/gitlab_schema.graphql | 89 | ||||
-rw-r--r-- | doc/api/graphql/reference/gitlab_schema.json | 46 | ||||
-rw-r--r-- | doc/api/graphql/reference/index.md | 44 |
3 files changed, 133 insertions, 46 deletions
diff --git a/doc/api/graphql/reference/gitlab_schema.graphql b/doc/api/graphql/reference/gitlab_schema.graphql index 8abe501eafc..12cb4aa78ee 100644 --- a/doc/api/graphql/reference/gitlab_schema.graphql +++ b/doc/api/graphql/reference/gitlab_schema.graphql @@ -1128,7 +1128,14 @@ enum EntryType { } type Epic implements Noteable { + """ + Author of the epic + """ author: User! + + """ + Children (sub-epics) of the epic + """ children( """ Returns the elements in the list that come after the specified cursor. @@ -1197,13 +1204,25 @@ type Epic implements Noteable { """ state: EpicState ): EpicConnection + + """ + Timestamp of the epic's closure + """ closedAt: Time + + """ + Timestamp of the epic's creation + """ createdAt: Time """ Number of open and closed descendant epics and issues """ descendantCounts: EpicDescendantCount + + """ + Description of the epic + """ description: String """ @@ -1235,14 +1254,50 @@ type Epic implements Noteable { Number of downvotes the epic has received """ downvotes: Int! + + """ + Due date of the epic + """ dueDate: Time + + """ + Fixed due date of the epic + """ dueDateFixed: Time + + """ + Inherited due date of the epic from milestones + """ dueDateFromMilestones: Time + + """ + Indicates if the due date has been manually set + """ dueDateIsFixed: Boolean + + """ + Group to which the epic belongs + """ group: Group! + + """ + Indicates if the epic has children + """ hasChildren: Boolean! + + """ + Indicates if the epic has direct issues + """ hasIssues: Boolean! + + """ + ID of the epic + """ id: ID! + + """ + Internal ID of the epic + """ iid: ID! """ @@ -1319,6 +1374,10 @@ type Epic implements Noteable { """ last: Int ): NoteConnection! + + """ + Parent epic of the epic + """ parent: Epic """ @@ -1349,20 +1408,48 @@ type Epic implements Noteable { relationPath: String """ - The relative position of the epic in the Epic tree + The relative position of the epic in the epic tree """ relativePosition: Int + + """ + Start date of the epic + """ startDate: Time + + """ + Fixed start date of the epic + """ startDateFixed: Time + + """ + Inherited start date of the epic from milestones + """ startDateFromMilestones: Time + + """ + Indicates if the start date has been manually set + """ startDateIsFixed: Boolean + + """ + State of the epic + """ state: EpicState! """ Boolean flag for whether the currently logged in user is subscribed to this epic """ subscribed: Boolean! + + """ + Title of the epic + """ title: String + + """ + Timestamp of the epic's last activity + """ updatedAt: Time """ diff --git a/doc/api/graphql/reference/gitlab_schema.json b/doc/api/graphql/reference/gitlab_schema.json index aa75d920997..a9ea0948217 100644 --- a/doc/api/graphql/reference/gitlab_schema.json +++ b/doc/api/graphql/reference/gitlab_schema.json @@ -3342,7 +3342,7 @@ "fields": [ { "name": "author", - "description": null, + "description": "Author of the epic", "args": [ ], @@ -3360,7 +3360,7 @@ }, { "name": "children", - "description": null, + "description": "Children (sub-epics) of the epic", "args": [ { "name": "iid", @@ -3519,7 +3519,7 @@ }, { "name": "closedAt", - "description": null, + "description": "Timestamp of the epic's closure", "args": [ ], @@ -3533,7 +3533,7 @@ }, { "name": "createdAt", - "description": null, + "description": "Timestamp of the epic's creation", "args": [ ], @@ -3561,7 +3561,7 @@ }, { "name": "description", - "description": null, + "description": "Description of the epic", "args": [ ], @@ -3650,7 +3650,7 @@ }, { "name": "dueDate", - "description": null, + "description": "Due date of the epic", "args": [ ], @@ -3664,7 +3664,7 @@ }, { "name": "dueDateFixed", - "description": null, + "description": "Fixed due date of the epic", "args": [ ], @@ -3678,7 +3678,7 @@ }, { "name": "dueDateFromMilestones", - "description": null, + "description": "Inherited due date of the epic from milestones", "args": [ ], @@ -3692,7 +3692,7 @@ }, { "name": "dueDateIsFixed", - "description": null, + "description": "Indicates if the due date has been manually set", "args": [ ], @@ -3706,7 +3706,7 @@ }, { "name": "group", - "description": null, + "description": "Group to which the epic belongs", "args": [ ], @@ -3724,7 +3724,7 @@ }, { "name": "hasChildren", - "description": null, + "description": "Indicates if the epic has children", "args": [ ], @@ -3742,7 +3742,7 @@ }, { "name": "hasIssues", - "description": null, + "description": "Indicates if the epic has direct issues", "args": [ ], @@ -3760,7 +3760,7 @@ }, { "name": "id", - "description": null, + "description": "ID of the epic", "args": [ ], @@ -3778,7 +3778,7 @@ }, { "name": "iid", - "description": null, + "description": "Internal ID of the epic", "args": [ ], @@ -3959,7 +3959,7 @@ }, { "name": "parent", - "description": null, + "description": "Parent epic of the epic", "args": [ ], @@ -4067,7 +4067,7 @@ }, { "name": "relativePosition", - "description": "The relative position of the epic in the Epic tree", + "description": "The relative position of the epic in the epic tree", "args": [ ], @@ -4081,7 +4081,7 @@ }, { "name": "startDate", - "description": null, + "description": "Start date of the epic", "args": [ ], @@ -4095,7 +4095,7 @@ }, { "name": "startDateFixed", - "description": null, + "description": "Fixed start date of the epic", "args": [ ], @@ -4109,7 +4109,7 @@ }, { "name": "startDateFromMilestones", - "description": null, + "description": "Inherited start date of the epic from milestones", "args": [ ], @@ -4123,7 +4123,7 @@ }, { "name": "startDateIsFixed", - "description": null, + "description": "Indicates if the start date has been manually set", "args": [ ], @@ -4137,7 +4137,7 @@ }, { "name": "state", - "description": null, + "description": "State of the epic", "args": [ ], @@ -4173,7 +4173,7 @@ }, { "name": "title", - "description": null, + "description": "Title of the epic", "args": [ ], @@ -4187,7 +4187,7 @@ }, { "name": "updatedAt", - "description": null, + "description": "Timestamp of the epic's last activity", "args": [ ], diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index e9c27ffc432..8d105e6c1ab 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -195,32 +195,32 @@ The API can be explored interactively using the [GraphiQL IDE](../index.md#graph | Name | Type | Description | | --- | ---- | ---------- | | `userPermissions` | EpicPermissions! | Permissions for the current user on the resource | -| `id` | ID! | | -| `iid` | ID! | | -| `title` | String | | -| `description` | String | | -| `state` | EpicState! | | -| `group` | Group! | | -| `parent` | Epic | | -| `author` | User! | | -| `startDate` | Time | | -| `startDateIsFixed` | Boolean | | -| `startDateFixed` | Time | | -| `startDateFromMilestones` | Time | | -| `dueDate` | Time | | -| `dueDateIsFixed` | Boolean | | -| `dueDateFixed` | Time | | -| `dueDateFromMilestones` | Time | | +| `id` | ID! | ID of the epic | +| `iid` | ID! | Internal ID of the epic | +| `title` | String | Title of the epic | +| `description` | String | Description of the epic | +| `state` | EpicState! | State of the epic | +| `group` | Group! | Group to which the epic belongs | +| `parent` | Epic | Parent epic of the epic | +| `author` | User! | Author of the epic | +| `startDate` | Time | Start date of the epic | +| `startDateIsFixed` | Boolean | Indicates if the start date has been manually set | +| `startDateFixed` | Time | Fixed start date of the epic | +| `startDateFromMilestones` | Time | Inherited start date of the epic from milestones | +| `dueDate` | Time | Due date of the epic | +| `dueDateIsFixed` | Boolean | Indicates if the due date has been manually set | +| `dueDateFixed` | Time | Fixed due date of the epic | +| `dueDateFromMilestones` | Time | Inherited due date of the epic from milestones | | `upvotes` | Int! | Number of upvotes the epic has received | | `downvotes` | Int! | Number of downvotes the epic has received | -| `closedAt` | Time | | -| `createdAt` | Time | | -| `updatedAt` | Time | | -| `hasChildren` | Boolean! | | -| `hasIssues` | Boolean! | | +| `closedAt` | Time | Timestamp of the epic's closure | +| `createdAt` | Time | Timestamp of the epic's creation | +| `updatedAt` | Time | Timestamp of the epic's last activity | +| `hasChildren` | Boolean! | Indicates if the epic has children | +| `hasIssues` | Boolean! | Indicates if the epic has direct issues | | `webPath` | String! | | | `webUrl` | String! | | -| `relativePosition` | Int | The relative position of the epic in the Epic tree | +| `relativePosition` | Int | The relative position of the epic in the epic tree | | `relationPath` | String | | | `reference` | String! | | | `subscribed` | Boolean! | Boolean flag for whether the currently logged in user is subscribed to this epic | |