Commit ce3795fd authored by Alex Kalderimis's avatar Alex Kalderimis

Update generated GraphQL documentation

Update automatically generated documentation
parent 655b77c5
...@@ -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
""" """
......
...@@ -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