diff options
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/graphql/reference/gitlab_schema.graphql | 23 | ||||
-rw-r--r-- | doc/api/graphql/reference/gitlab_schema.json | 10 | ||||
-rw-r--r-- | doc/api/graphql/reference/index.md | 8 |
3 files changed, 31 insertions, 10 deletions
diff --git a/doc/api/graphql/reference/gitlab_schema.graphql b/doc/api/graphql/reference/gitlab_schema.graphql index 125009adc35..c8a91d830a0 100644 --- a/doc/api/graphql/reference/gitlab_schema.graphql +++ b/doc/api/graphql/reference/gitlab_schema.graphql @@ -1986,7 +1986,20 @@ type Epic implements Noteable { """ last: Int ): UserConnection - reference(full: Boolean = false): String! + + """ + Internal reference of the epic. Returned in shortened format by default + """ + reference( + """ + Indicates if the reference should be returned in full + """ + full: Boolean = false + ): String! + + """ + URI path of the epic-issue relationship + """ relationPath: String """ @@ -2043,7 +2056,15 @@ type Epic implements Noteable { Permissions for the current user on the resource """ userPermissions: EpicPermissions! + + """ + Web path of the epic + """ webPath: String! + + """ + Web URL of the epic + """ webUrl: String! } diff --git a/doc/api/graphql/reference/gitlab_schema.json b/doc/api/graphql/reference/gitlab_schema.json index 17a3d8eb2e2..08b84a1ca35 100644 --- a/doc/api/graphql/reference/gitlab_schema.json +++ b/doc/api/graphql/reference/gitlab_schema.json @@ -5013,11 +5013,11 @@ }, { "name": "reference", - "description": null, + "description": "Internal reference of the epic. Returned in shortened format by default", "args": [ { "name": "full", - "description": null, + "description": "Indicates if the reference should be returned in full", "type": { "kind": "SCALAR", "name": "Boolean", @@ -5040,7 +5040,7 @@ }, { "name": "relationPath", - "description": null, + "description": "URI path of the epic-issue relationship", "args": [ ], @@ -5224,7 +5224,7 @@ }, { "name": "webPath", - "description": null, + "description": "Web path of the epic", "args": [ ], @@ -5242,7 +5242,7 @@ }, { "name": "webUrl", - "description": null, + "description": "Web URL of the epic", "args": [ ], diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index beffd29d884..5e0b7465c20 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -295,8 +295,8 @@ Represents an epic. | `id` | ID! | ID of the epic | | `iid` | ID! | Internal ID of the epic | | `parent` | Epic | Parent epic of the epic | -| `reference` | String! | | -| `relationPath` | String | | +| `reference` | String! | Internal reference of the epic. Returned in shortened format by default | +| `relationPath` | String | URI path of the epic-issue relationship | | `relativePosition` | Int | The relative position of the epic in the epic tree | | `startDate` | Time | Start date of the epic | | `startDateFixed` | Time | Fixed start date of the epic | @@ -308,8 +308,8 @@ Represents an epic. | `updatedAt` | Time | Timestamp of the epic's last activity | | `upvotes` | Int! | Number of upvotes the epic has received | | `userPermissions` | EpicPermissions! | Permissions for the current user on the resource | -| `webPath` | String! | | -| `webUrl` | String! | | +| `webPath` | String! | Web path of the epic | +| `webUrl` | String! | Web URL of the epic | ## EpicDescendantCount |