diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-01-23 00:08:53 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-01-23 00:08:53 +0000 |
commit | d65442b1d9621da6749d59ea1a544a2ea39b3a79 (patch) | |
tree | 0aa6fb67b70c38cdd949a2b4002ceb459860fa82 /doc | |
parent | b6ec12ceca58b12d974d46d0579742f4d3cdb9d7 (diff) | |
download | gitlab-ce-d65442b1d9621da6749d59ea1a544a2ea39b3a79.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/graphql/reference/gitlab_schema.graphql | 240 | ||||
-rw-r--r-- | doc/api/graphql/reference/gitlab_schema.json | 692 | ||||
-rw-r--r-- | doc/api/graphql/reference/index.md | 31 |
3 files changed, 962 insertions, 1 deletions
diff --git a/doc/api/graphql/reference/gitlab_schema.graphql b/doc/api/graphql/reference/gitlab_schema.graphql index 7d18a0abfe5..4e083142514 100644 --- a/doc/api/graphql/reference/gitlab_schema.graphql +++ b/doc/api/graphql/reference/gitlab_schema.graphql @@ -655,6 +655,16 @@ type Design implements DesignFields & Noteable { before: String """ + The Global ID of the most recent acceptable version + """ + earlierOrEqualToId: ID + + """ + The SHA256 of the most recent acceptable version + """ + earlierOrEqualToSha: String + + """ Returns the first _n_ elements from the list. """ first: Int @@ -667,10 +677,130 @@ type Design implements DesignFields & Noteable { } """ +A design pinned to a specific version. The image field reflects the design as of the associated version. +""" +type DesignAtVersion implements DesignFields { + """ + The underlying design. + """ + design: Design! + + """ + The diff refs for this design + """ + diffRefs: DiffRefs! + + """ + How this design was changed in the current version + """ + event: DesignVersionEvent! + + """ + The filename of the design + """ + filename: String! + + """ + The full path to the design file + """ + fullPath: String! + + """ + The ID of this design + """ + id: ID! + + """ + The URL of the image + """ + image: String! + + """ + The issue the design belongs to + """ + issue: Issue! + + """ + The total count of user-created notes for this design + """ + notesCount: Int! + + """ + The project the design belongs to + """ + project: Project! + + """ + The version this design-at-versions is pinned to + """ + version: DesignVersion! +} + +""" +The connection type for DesignAtVersion. +""" +type DesignAtVersionConnection { + """ + A list of edges. + """ + edges: [DesignAtVersionEdge] + + """ + A list of nodes. + """ + nodes: [DesignAtVersion] + + """ + Information to aid in pagination. + """ + pageInfo: PageInfo! +} + +""" +An edge in a connection. +""" +type DesignAtVersionEdge { + """ + A cursor for use in pagination. + """ + cursor: String! + + """ + The item at the end of the edge. + """ + node: DesignAtVersion +} + +""" A collection of designs. """ type DesignCollection { """ + Find a specific design + """ + design( + """ + Find a design by its filename + """ + filename: String + + """ + Find a design by its ID + """ + id: ID + ): Design + + """ + Find a design as of a version + """ + designAtVersion( + """ + The Global ID of the design at this version + """ + id: ID! + ): DesignAtVersion + + """ All designs for the design collection """ designs( @@ -722,6 +852,21 @@ type DesignCollection { project: Project! """ + A specific version + """ + version( + """ + The Global ID of the version + """ + id: ID + + """ + The SHA256 of a specific version + """ + sha: String + ): DesignVersion + + """ All versions related to all designs, ordered newest first """ versions( @@ -736,6 +881,16 @@ type DesignCollection { before: String """ + The Global ID of the most recent acceptable version + """ + earlierOrEqualToId: ID + + """ + The SHA256 of the most recent acceptable version + """ + earlierOrEqualToSha: String + + """ Returns the first _n_ elements from the list. """ first: Int @@ -829,6 +984,28 @@ interface DesignFields { project: Project! } +type DesignManagement { + """ + Find a design as of a version + """ + designAtVersion( + """ + The Global ID of the design at this version + """ + id: ID! + ): DesignAtVersion + + """ + Find a version + """ + version( + """ + The Global ID of the version + """ + id: ID! + ): DesignVersion +} + """ Autogenerated input type of DesignManagementDelete """ @@ -924,8 +1101,31 @@ type DesignManagementUploadPayload { skippedDesigns: [Design!]! } +""" +A specific version in which designs were added, modified or deleted +""" type DesignVersion { """ + A particular design as of this version, provided it is visible at this version + """ + designAtVersion( + """ + The ID of a specific design + """ + designId: ID + + """ + The filename of a specific design + """ + filename: String + + """ + The ID of the DesignAtVersion + """ + id: ID + ): DesignAtVersion! + + """ All designs that were changed in the version """ designs( @@ -951,6 +1151,41 @@ type DesignVersion { ): DesignConnection! """ + All designs that are visible at this version, as of this version + """ + designsAtVersion( + """ + 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 + + """ + Filters designs by their filename + """ + filenames: [String!] + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Filters designs by their ID + """ + ids: [ID!] + + """ + Returns the last _n_ elements from the list. + """ + last: Int + ): DesignAtVersionConnection! + + """ ID of the design version """ id: ID! @@ -5605,6 +5840,11 @@ type Query { currentUser: User """ + Fields related to design management + """ + designManagement: DesignManagement! + + """ Text to echo back """ echo( diff --git a/doc/api/graphql/reference/gitlab_schema.json b/doc/api/graphql/reference/gitlab_schema.json index 9f888eb89c4..5c1c05d6d4e 100644 --- a/doc/api/graphql/reference/gitlab_schema.json +++ b/doc/api/graphql/reference/gitlab_schema.json @@ -49,6 +49,24 @@ "deprecationReason": null }, { + "name": "designManagement", + "description": "Fields related to design management", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DesignManagement", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "echo", "description": "Text to echo back", "args": [ @@ -9737,6 +9755,66 @@ "description": "A collection of designs.", "fields": [ { + "name": "design", + "description": "Find a specific design", + "args": [ + { + "name": "id", + "description": "Find a design by its ID", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "filename", + "description": "Find a design by its filename", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Design", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "designAtVersion", + "description": "Find a design as of a version", + "args": [ + { + "name": "id", + "description": "The Global ID of the design at this version", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DesignAtVersion", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "designs", "description": "All designs for the design collection", "args": [ @@ -9876,10 +9954,63 @@ "deprecationReason": null }, { + "name": "version", + "description": "A specific version", + "args": [ + { + "name": "sha", + "description": "The SHA256 of a specific version", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "id", + "description": "The Global ID of the version", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DesignVersion", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "versions", "description": "All versions related to all designs, ordered newest first", "args": [ { + "name": "earlierOrEqualToSha", + "description": "The SHA256 of the most recent acceptable version", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "earlierOrEqualToId", + "description": "The Global ID of the most recent acceptable version", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { "name": "after", "description": "Returns the elements in the list that come after the specified cursor.", "type": { @@ -11133,6 +11264,26 @@ "description": "All versions related to this design ordered newest first", "args": [ { + "name": "earlierOrEqualToSha", + "description": "The SHA256 of the most recent acceptable version", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "earlierOrEqualToId", + "description": "The Global ID of the most recent acceptable version", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { "name": "after", "description": "Returns the elements in the list that come after the specified cursor.", "type": { @@ -11378,6 +11529,11 @@ "kind": "OBJECT", "name": "Design", "ofType": null + }, + { + "kind": "OBJECT", + "name": "DesignAtVersion", + "ofType": null } ] }, @@ -11531,9 +11687,56 @@ { "kind": "OBJECT", "name": "DesignVersion", - "description": null, + "description": "A specific version in which designs were added, modified or deleted", "fields": [ { + "name": "designAtVersion", + "description": "A particular design as of this version, provided it is visible at this version", + "args": [ + { + "name": "id", + "description": "The ID of the DesignAtVersion", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "designId", + "description": "The ID of a specific design", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "filename", + "description": "The filename of a specific design", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DesignAtVersion", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "designs", "description": "All designs that were changed in the version", "args": [ @@ -11591,6 +11794,99 @@ "deprecationReason": null }, { + "name": "designsAtVersion", + "description": "All designs that are visible at this version, as of this version", + "args": [ + { + "name": "ids", + "description": "Filters designs by their ID", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "filenames", + "description": "Filters designs by their filename", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "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": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DesignAtVersionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "id", "description": "ID of the design version", "args": [ @@ -11636,6 +11932,333 @@ }, { "kind": "OBJECT", + "name": "DesignAtVersionConnection", + "description": "The connection type for DesignAtVersion.", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [ + + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DesignAtVersionEdge", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of nodes.", + "args": [ + + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DesignAtVersion", + "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": "DesignAtVersionEdge", + "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": "OBJECT", + "name": "DesignAtVersion", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DesignAtVersion", + "description": "A design pinned to a specific version. The image field reflects the design as of the associated version.", + "fields": [ + { + "name": "design", + "description": "The underlying design.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Design", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "diffRefs", + "description": "The diff refs for this design", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiffRefs", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "event", + "description": "How this design was changed in the current version", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DesignVersionEvent", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "filename", + "description": "The filename of the design", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fullPath", + "description": "The full path to the design file", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The ID of this design", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "image", + "description": "The URL of the image", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "issue", + "description": "The issue the design belongs to", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Issue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "notesCount", + "description": "The total count of user-created notes for this design", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "project", + "description": "The project the design belongs to", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Project", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "version", + "description": "The version this design-at-versions is pinned to", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DesignVersion", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DesignFields", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", "name": "EpicDescendantCount", "description": "Counts of descendent epics.", "fields": [ @@ -16745,6 +17368,73 @@ }, { "kind": "OBJECT", + "name": "DesignManagement", + "description": null, + "fields": [ + { + "name": "designAtVersion", + "description": "Find a design as of a version", + "args": [ + { + "name": "id", + "description": "The Global ID of the design at this version", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DesignAtVersion", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "version", + "description": "Find a version", + "args": [ + { + "name": "id", + "description": "The Global ID of the version", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DesignVersion", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", "name": "Mutation", "description": null, "fields": [ diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index 1177ffff36c..87e83090394 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -130,6 +130,24 @@ A single design | `event` | DesignVersionEvent! | How this design was changed in the current version | | `notesCount` | Int! | The total count of user-created notes for this design | +## DesignAtVersion + +A design pinned to a specific version. The image field reflects the design as of the associated version. + +| Name | Type | Description | +| --- | ---- | ---------- | +| `id` | ID! | The ID of this design | +| `project` | Project! | The project the design belongs to | +| `issue` | Issue! | The issue the design belongs to | +| `filename` | String! | The filename of the design | +| `fullPath` | String! | The full path to the design file | +| `image` | String! | The URL of the image | +| `diffRefs` | DiffRefs! | The diff refs for this design | +| `event` | DesignVersionEvent! | How this design was changed in the current version | +| `notesCount` | Int! | The total count of user-created notes for this design | +| `version` | DesignVersion! | The version this design-at-versions is pinned to | +| `design` | Design! | The underlying design. | + ## DesignCollection A collection of designs. @@ -138,6 +156,16 @@ A collection of designs. | --- | ---- | ---------- | | `project` | Project! | Project associated with the design collection | | `issue` | Issue! | Issue associated with the design collection | +| `version` | DesignVersion | A specific version | +| `designAtVersion` | DesignAtVersion | Find a design as of a version | +| `design` | Design | Find a specific design | + +## DesignManagement + +| Name | Type | Description | +| --- | ---- | ---------- | +| `version` | DesignVersion | Find a version | +| `designAtVersion` | DesignAtVersion | Find a design as of a version | ## DesignManagementDeletePayload @@ -162,10 +190,13 @@ Autogenerated return type of DesignManagementUpload ## DesignVersion +A specific version in which designs were added, modified or deleted + | Name | Type | Description | | --- | ---- | ---------- | | `id` | ID! | ID of the design version | | `sha` | ID! | SHA of the design version | +| `designAtVersion` | DesignAtVersion! | A particular design as of this version, provided it is visible at this version | ## DestroyNotePayload |