Skip to content

G
gitlab-ce
Commit c15364de authored by Mike Kozono's avatar Mike Kozono
Browse files
Options

Autogenerate GraphQL schema and docs

parent decd2c8f
Hide whitespace changes
Inline Side-by-side
Showing with 501 additions and 0 deletions
doc/api/graphql/reference/gitlab_schema.graphql
View file @ c15364de
......@@ -3405,6 +3405,36 @@ type GeoNode {
"""
name: String
"""
Package file registries of the GeoNode. Available only when feature flag `geo_self_service_framework` is enabled
"""
packageFileRegistries(
"""
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
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Filters registries by their ID
"""
ids: [ID!]
"""
Returns the last _n_ elements from the list.
"""
last: Int
): PackageFileRegistryConnection
"""
Indicates whether this Geo node is the primary
"""
......@@ -6273,6 +6303,86 @@ interface Noteable {
): NoteConnection!
}
"""
Represents the sync and verification state of a package file
"""
type PackageFileRegistry {
"""
Timestamp when the PackageFileRegistry was created
"""
createdAt: Time
"""
ID of the PackageFileRegistry
"""
id: ID!
"""
Error message during sync of the PackageFileRegistry
"""
lastSyncFailure: String
"""
Timestamp of the most recent successful sync of the PackageFileRegistry
"""
lastSyncedAt: Time
"""
ID of the PackageFile
"""
packageFileId: ID!
"""
Timestamp after which the PackageFileRegistry should be resynced
"""
retryAt: Time
"""
Number of consecutive failed sync attempts of the PackageFileRegistry
"""
retryCount: Int
"""
Sync state of the PackageFileRegistry
"""
state: RegistryState
}
"""
The connection type for PackageFileRegistry.
"""
type PackageFileRegistryConnection {
"""
A list of edges.
"""
edges: [PackageFileRegistryEdge]
"""
A list of nodes.
"""
nodes: [PackageFileRegistry]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
}
"""
An edge in a connection.
"""
type PackageFileRegistryEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: PackageFileRegistry
}
"""
Information about pagination in a connection.
"""
......@@ -7749,6 +7859,31 @@ type Query {
): VulnerabilityConnection
}
"""
State of a Geo registry.
"""
enum RegistryState {
"""
Registry that failed to sync
"""
FAILED
"""
Registry waiting to be synced
"""
PENDING
"""
Registry currently syncing
"""
STARTED
"""
Registry that is synced
"""
SYNCED
}
"""
Autogenerated input type of RemoveAwardEmoji
"""
......
doc/api/graphql/reference/gitlab_schema.json
View file @ c15364de
......@@ -9764,6 +9764,77 @@
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "packageFileRegistries",
"description": "Package file registries of the GeoNode. Available only when feature flag `geo_self_service_framework` is enabled",
"args": [
{
"name": "ids",
"description": "Filters registries by their ID",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"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": "OBJECT",
"name": "PackageFileRegistryConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "primary",
"description": "Indicates whether this Geo node is the primary",
......@@ -18890,6 +18961,251 @@
}
]
},
{
"kind": "OBJECT",
"name": "PackageFileRegistry",
"description": "Represents the sync and verification state of a package file",
"fields": [
{
"name": "createdAt",
"description": "Timestamp when the PackageFileRegistry was created",
"args": [
],
"type": {
"kind": "SCALAR",
"name": "Time",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of the PackageFileRegistry",
"args": [
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lastSyncFailure",
"description": "Error message during sync of the PackageFileRegistry",
"args": [
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lastSyncedAt",
"description": "Timestamp of the most recent successful sync of the PackageFileRegistry",
"args": [
],
"type": {
"kind": "SCALAR",
"name": "Time",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "packageFileId",
"description": "ID of the PackageFile",
"args": [
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "retryAt",
"description": "Timestamp after which the PackageFileRegistry should be resynced",
"args": [
],
"type": {
"kind": "SCALAR",
"name": "Time",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "retryCount",
"description": "Number of consecutive failed sync attempts of the PackageFileRegistry",
"args": [
],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "state",
"description": "Sync state of the PackageFileRegistry",
"args": [
],
"type": {
"kind": "ENUM",
"name": "RegistryState",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PackageFileRegistryConnection",
"description": "The connection type for PackageFileRegistry.",
"fields": [
{
"name": "edges",
"description": "A list of edges.",
"args": [
],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PackageFileRegistryEdge",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "nodes",
"description": "A list of nodes.",
"args": [
],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PackageFileRegistry",
"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": "PackageFileRegistryEdge",
"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": "PackageFileRegistry",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PageInfo",
......@@ -23038,6 +23354,41 @@
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "RegistryState",
"description": "State of a Geo registry.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "PENDING",
"description": "Registry waiting to be synced",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "STARTED",
"description": "Registry currently syncing",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SYNCED",
"description": "Registry that is synced",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FAILED",
"description": "Registry that failed to sync",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "RemoveAwardEmojiInput",
......
doc/api/graphql/reference/index.md
View file @ c15364de
......@@ -950,6 +950,21 @@ Represents a milestone.
| `readNote` | Boolean! | Indicates the user can perform `read_note` on this resource |
| `resolveNote` | Boolean! | Indicates the user can perform `resolve_note` on this resource |
## PackageFileRegistry
Represents the sync and verification state of a package file
| Name | Type | Description |
| --- | ---- | ---------- |
| `createdAt` | Time | Timestamp when the PackageFileRegistry was created |
| `id` | ID! | ID of the PackageFileRegistry |
| `lastSyncFailure` | String | Error message during sync of the PackageFileRegistry |
| `lastSyncedAt` | Time | Timestamp of the most recent successful sync of the PackageFileRegistry |
| `packageFileId` | ID! | ID of the PackageFile |
| `retryAt` | Time | Timestamp after which the PackageFileRegistry should be resynced |
| `retryCount` | Int | Number of consecutive failed sync attempts of the PackageFileRegistry |
| `state` | RegistryState | Sync state of the PackageFileRegistry |
## PageInfo
Information about pagination in a connection.
......
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