Skip to content

G
gitlab-ce
Commit ce3795fd authored by Alex Kalderimis's avatar Alex Kalderimis
Browse files
Options

Update generated GraphQL documentation 

Update automatically generated documentation
parent 655b77c5
Hide whitespace changes
Inline Side-by-side
Showing with 969 additions and 8 deletions
doc/api/graphql/reference/gitlab_schema.graphql
View file @ ce3795fd
...@@ -645,6 +645,16 @@ type Design implements DesignFields & Noteable { ...@@ -645,6 +645,16 @@ type Design implements DesignFields & Noteable {
""" """
before: String 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. Returns the first _n_ elements from the list.
""" """
...@@ -657,10 +667,130 @@ type Design implements DesignFields & Noteable { ...@@ -657,10 +667,130 @@ type Design implements DesignFields & Noteable {
): DesignVersionConnection! ): DesignVersionConnection!
} }
"""
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. A collection of designs.
""" """
type DesignCollection { 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 All designs for the design collection
""" """
...@@ -712,6 +842,21 @@ type DesignCollection { ...@@ -712,6 +842,21 @@ type DesignCollection {
""" """
project: Project! 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 All versions related to all designs, ordered newest first
""" """
...@@ -726,6 +871,16 @@ type DesignCollection { ...@@ -726,6 +871,16 @@ type DesignCollection {
""" """
before: String 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. Returns the first _n_ elements from the list.
""" """
...@@ -820,6 +975,28 @@ interface DesignFields { ...@@ -820,6 +975,28 @@ interface DesignFields {
project: Project! 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 Autogenerated input type of DesignManagementDelete
""" """
...@@ -915,7 +1092,30 @@ type DesignManagementUploadPayload { ...@@ -915,7 +1092,30 @@ type DesignManagementUploadPayload {
skippedDesigns: [Design!]! skippedDesigns: [Design!]!
} }
"""
A specific version in which designs were added, modified or deleted
"""
type DesignVersion { 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 All designs that were changed in the version
""" """
...@@ -941,6 +1141,41 @@ type DesignVersion { ...@@ -941,6 +1141,41 @@ type DesignVersion {
last: Int last: Int
): DesignConnection! ): 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 of the design version
""" """
...@@ -5560,6 +5795,11 @@ type Query { ...@@ -5560,6 +5795,11 @@ type Query {
""" """
currentUser: User currentUser: User
"""
Fields related to design management
"""
designManagement: DesignManagement!
""" """
Text to echo back Text to echo back
""" """
......
doc/api/graphql/reference/gitlab_schema.json
View file @ ce3795fd
...@@ -48,6 +48,24 @@ ...@@ -48,6 +48,24 @@
"isDeprecated": false, "isDeprecated": false,
"deprecationReason": null "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", "name": "echo",
"description": "Text to echo back", "description": "Text to echo back",
...@@ -9333,6 +9351,66 @@ ...@@ -9333,6 +9351,66 @@
"name": "DesignCollection", "name": "DesignCollection",
"description": "A collection of designs.", "description": "A collection of designs.",
"fields": [ "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", "name": "designs",
"description": "All designs for the design collection", "description": "All designs for the design collection",
...@@ -9472,10 +9550,63 @@ ...@@ -9472,10 +9550,63 @@
"isDeprecated": false, "isDeprecated": false,
"deprecationReason": null "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", "name": "versions",
"description": "All versions related to all designs, ordered newest first", "description": "All versions related to all designs, ordered newest first",
"args": [ "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", "name": "after",
"description": "Returns the elements in the list that come after the specified cursor.", "description": "Returns the elements in the list that come after the specified cursor.",
...@@ -10729,6 +10860,26 @@ ...@@ -10729,6 +10860,26 @@
"name": "versions", "name": "versions",
"description": "All versions related to this design ordered newest first", "description": "All versions related to this design ordered newest first",
"args": [ "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", "name": "after",
"description": "Returns the elements in the list that come after the specified cursor.", "description": "Returns the elements in the list that come after the specified cursor.",
...@@ -10975,6 +11126,11 @@ ...@@ -10975,6 +11126,11 @@
"kind": "OBJECT", "kind": "OBJECT",
"name": "Design", "name": "Design",
"ofType": null "ofType": null
},
{
"kind": "OBJECT",
"name": "DesignAtVersion",
"ofType": null
} }
] ]
}, },
...@@ -11128,8 +11284,55 @@ ...@@ -11128,8 +11284,55 @@
{ {
"kind": "OBJECT", "kind": "OBJECT",
"name": "DesignVersion", "name": "DesignVersion",
"description": null, "description": "A specific version in which designs were added, modified or deleted",
"fields": [ "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", "name": "designs",
"description": "All designs that were changed in the version", "description": "All designs that were changed in the version",
...@@ -11188,17 +11391,92 @@ ...@@ -11188,17 +11391,92 @@
"deprecationReason": null "deprecationReason": null
}, },
{ {
"name": "id", "name": "designsAtVersion",
"description": "ID of the design version", "description": "All designs that are visible at this version, as of this version",
"args": [ "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": { "type": {
"kind": "NON_NULL", "kind": "NON_NULL",
"name": null, "name": null,
"ofType": { "ofType": {
"kind": "SCALAR", "kind": "OBJECT",
"name": "ID", "name": "DesignAtVersionConnection",
"ofType": null "ofType": null
} }
}, },
...@@ -11206,8 +11484,8 @@ ...@@ -11206,8 +11484,8 @@
"deprecationReason": null "deprecationReason": null
}, },
{ {
"name": "sha", "name": "id",
"description": "SHA of the design version", "description": "ID of the design version",
"args": [ "args": [
], ],
...@@ -11222,6 +11500,136 @@ ...@@ -11222,6 +11500,136 @@
}, },
"isDeprecated": false, "isDeprecated": false,
"deprecationReason": null "deprecationReason": null
},
{
"name": "sha",
"description": "SHA of the design version",
"args": [
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
],
"enumValues": null,
"possibleTypes": null
},
{
"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, "inputFields": null,
...@@ -11231,6 +11639,221 @@ ...@@ -11231,6 +11639,221 @@
"enumValues": null, "enumValues": null,
"possibleTypes": 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", "kind": "OBJECT",
"name": "EpicDescendantCount", "name": "EpicDescendantCount",
...@@ -16340,6 +16963,73 @@ ...@@ -16340,6 +16963,73 @@
"enumValues": null, "enumValues": null,
"possibleTypes": null "possibleTypes": null
}, },
{
"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", "kind": "OBJECT",
"name": "Mutation", "name": "Mutation",
......
doc/api/graphql/reference/index.md
View file @ ce3795fd
...@@ -130,6 +130,24 @@ A single design ...@@ -130,6 +130,24 @@ A single design
| `event` | DesignVersionEvent! | How this design was changed in the current version | | `event` | DesignVersionEvent! | How this design was changed in the current version |
| `notesCount` | Int! | The total count of user-created notes for this design | | `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 ## DesignCollection
A collection of designs. A collection of designs.
...@@ -138,6 +156,16 @@ A collection of designs. ...@@ -138,6 +156,16 @@ A collection of designs.
| --- | ---- | ---------- | | --- | ---- | ---------- |
| `project` | Project! | Project associated with the design collection | | `project` | Project! | Project associated with the design collection |
| `issue` | Issue! | Issue 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 ## DesignManagementDeletePayload
...@@ -162,10 +190,13 @@ Autogenerated return type of DesignManagementUpload ...@@ -162,10 +190,13 @@ Autogenerated return type of DesignManagementUpload
## DesignVersion ## DesignVersion
A specific version in which designs were added, modified or deleted
| Name | Type | Description | | Name | Type | Description |
| --- | ---- | ---------- | | --- | ---- | ---------- |
| `id` | ID! | ID of the design version | | `id` | ID! | ID of the design version |
| `sha` | ID! | SHA 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 ## DestroyNotePayload
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7