Skip to content

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

Add schema docs for design-at-version-types

parent 0e9fc90f
Hide whitespace changes
Inline Side-by-side
Showing with 261 additions and 31 deletions
doc/api/graphql/reference/gitlab_schema.graphql
View file @ e4f91bdc
...@@ -529,9 +529,9 @@ type CreateSnippetPayload { ...@@ -529,9 +529,9 @@ type CreateSnippetPayload {
snippet: Snippet snippet: Snippet
} }
type Design implements Noteable { type Design implements DesignFields & Noteable {
""" """
Diff refs of the design The diff refs for this design
""" """
diffRefs: DiffRefs! diffRefs: DiffRefs!
...@@ -561,33 +561,32 @@ type Design implements Noteable { ...@@ -561,33 +561,32 @@ type Design implements Noteable {
): DiscussionConnection! ): DiscussionConnection!
""" """
Type of change made to the design at the version specified by the `atVersion` How this design was changed in the current version
argument if supplied. Defaults to the latest version
""" """
event: DesignVersionEvent! event: DesignVersionEvent!
""" """
Filename of the design file The filename of the design
""" """
filename: String! filename: String!
""" """
Full path of the design file The full path to the design file
""" """
fullPath: String! fullPath: String!
""" """
ID of the design The ID of this design
""" """
id: ID! id: ID!
""" """
Image of the design The URL of the image
""" """
image: String! image: String!
""" """
Issue associated with the design The issue the design belongs to
""" """
issue: Issue! issue: Issue!
...@@ -617,17 +616,17 @@ type Design implements Noteable { ...@@ -617,17 +616,17 @@ type Design implements Noteable {
): NoteConnection! ): NoteConnection!
""" """
Total count of user-created notes for the design The total count of user-created notes for this design
""" """
notesCount: Int! notesCount: Int!
""" """
Project associated with the design The project the design belongs to
""" """
project: Project! project: Project!
""" """
All versions related to the design, ordered newest first All versions related to this design ordered newest first
""" """
versions( versions(
""" """
...@@ -765,6 +764,53 @@ type DesignEdge { ...@@ -765,6 +764,53 @@ type DesignEdge {
node: Design node: Design
} }
interface DesignFields {
"""
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!
}
""" """
Autogenerated input type of DesignManagementDelete Autogenerated input type of DesignManagementDelete
""" """
......
doc/api/graphql/reference/gitlab_schema.json
View file @ e4f91bdc
...@@ -10322,7 +10322,7 @@ ...@@ -10322,7 +10322,7 @@
"fields": [ "fields": [
{ {
"name": "diffRefs", "name": "diffRefs",
"description": "Diff refs of the design", "description": "The diff refs for this design",
"args": [ "args": [
], ],
...@@ -10397,7 +10397,7 @@ ...@@ -10397,7 +10397,7 @@
}, },
{ {
"name": "event", "name": "event",
"description": "Type of change made to the design at the version specified by the `atVersion` argument if supplied. Defaults to the latest version", "description": "How this design was changed in the current version",
"args": [ "args": [
], ],
...@@ -10415,7 +10415,7 @@ ...@@ -10415,7 +10415,7 @@
}, },
{ {
"name": "filename", "name": "filename",
"description": "Filename of the design file", "description": "The filename of the design",
"args": [ "args": [
], ],
...@@ -10433,7 +10433,7 @@ ...@@ -10433,7 +10433,7 @@
}, },
{ {
"name": "fullPath", "name": "fullPath",
"description": "Full path of the design file", "description": "The full path to the design file",
"args": [ "args": [
], ],
...@@ -10451,7 +10451,7 @@ ...@@ -10451,7 +10451,7 @@
}, },
{ {
"name": "id", "name": "id",
"description": "ID of the design", "description": "The ID of this design",
"args": [ "args": [
], ],
...@@ -10469,7 +10469,7 @@ ...@@ -10469,7 +10469,7 @@
}, },
{ {
"name": "image", "name": "image",
"description": "Image of the design", "description": "The URL of the image",
"args": [ "args": [
], ],
...@@ -10487,7 +10487,7 @@ ...@@ -10487,7 +10487,7 @@
}, },
{ {
"name": "issue", "name": "issue",
"description": "Issue associated with the design", "description": "The issue the design belongs to",
"args": [ "args": [
], ],
...@@ -10562,7 +10562,7 @@ ...@@ -10562,7 +10562,7 @@
}, },
{ {
"name": "notesCount", "name": "notesCount",
"description": "Total count of user-created notes for the design", "description": "The total count of user-created notes for this design",
"args": [ "args": [
], ],
...@@ -10580,7 +10580,7 @@ ...@@ -10580,7 +10580,7 @@
}, },
{ {
"name": "project", "name": "project",
"description": "Project associated with the design", "description": "The project the design belongs to",
"args": [ "args": [
], ],
...@@ -10598,7 +10598,7 @@ ...@@ -10598,7 +10598,7 @@
}, },
{ {
"name": "versions", "name": "versions",
"description": "All versions related to the design, ordered newest first", "description": "All versions related to this design ordered newest first",
"args": [ "args": [
{ {
"name": "after", "name": "after",
...@@ -10660,11 +10660,195 @@ ...@@ -10660,11 +10660,195 @@
"kind": "INTERFACE", "kind": "INTERFACE",
"name": "Noteable", "name": "Noteable",
"ofType": null "ofType": null
},
{
"kind": "INTERFACE",
"name": "DesignFields",
"ofType": null
} }
], ],
"enumValues": null, "enumValues": null,
"possibleTypes": null "possibleTypes": null
}, },
{
"kind": "INTERFACE",
"name": "DesignFields",
"description": null,
"fields": [
{
"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
}
],
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "Design",
"ofType": null
}
]
},
{ {
"kind": "ENUM", "kind": "ENUM",
"name": "DesignVersionEvent", "name": "DesignVersionEvent",
......
doc/api/graphql/reference/index.md
View file @ e4f91bdc
...@@ -104,15 +104,15 @@ The API can be explored interactively using the [GraphiQL IDE](../index.md#graph ...@@ -104,15 +104,15 @@ The API can be explored interactively using the [GraphiQL IDE](../index.md#graph
| Name | Type | Description | | Name | Type | Description |
| --- | ---- | ---------- | | --- | ---- | ---------- |
| `id` | ID! | ID of the design | | `id` | ID! | The ID of this design |
| `project` | Project! | Project associated with the design | | `project` | Project! | The project the design belongs to |
| `issue` | Issue! | Issue associated with the design | | `issue` | Issue! | The issue the design belongs to |
| `notesCount` | Int! | Total count of user-created notes for the design | | `filename` | String! | The filename of the design |
| `filename` | String! | Filename of the design file | | `fullPath` | String! | The full path to the design file |
| `fullPath` | String! | Full path of the design file | | `image` | String! | The URL of the image |
| `event` | DesignVersionEvent! | Type of change made to the design at the version specified by the `atVersion` argument if supplied. Defaults to the latest version | | `diffRefs` | DiffRefs! | The diff refs for this design |
| `image` | String! | Image of the design | | `event` | DesignVersionEvent! | How this design was changed in the current version |
| `diffRefs` | DiffRefs! | Diff refs of the design | | `notesCount` | Int! | The total count of user-created notes for this design |
### DesignCollection ### DesignCollection
......
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