Skip to content

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

Update GraphQL documentation

parent 671d5b51
Hide whitespace changes
Inline Side-by-side
Showing with 714 additions and 609 deletions
doc/api/graphql/reference/gitlab_schema.graphql
View file @ b97743da
...@@ -3879,6 +3879,21 @@ Identifier of ComplianceManagement::Framework. ...@@ -3879,6 +3879,21 @@ Identifier of ComplianceManagement::Framework.
""" """
scalar ComplianceManagementFrameworkID scalar ComplianceManagementFrameworkID
"""
Composer metadata
"""
type ComposerMetadata {
"""
Data of the Composer JSON file.
"""
composerJson: PackageComposerJsonType!
"""
Target SHA of the package.
"""
targetSha: String!
}
""" """
Autogenerated input type of ConfigureSast Autogenerated input type of ConfigureSast
""" """
...@@ -16880,142 +16895,27 @@ Represents a package in the Package Registry ...@@ -16880,142 +16895,27 @@ Represents a package in the Package Registry
""" """
type Package { type Package {
""" """
The created date. Date of creation.
""" """
createdAt: Time! createdAt: Time!
""" """
The ID of the package. ID of the package.
"""
id: ID!
"""
The name of the package.
"""
name: String!
"""
The type of the package.
"""
packageType: PackageTypeEnum!
"""
Pipelines that built the package.
""" """
pipelines( id: PackagesPackageID!
"""
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
"""
Returns the last _n_ elements from the list.
"""
last: Int
): PipelineConnection
""" """
Project where the package is stored. Package metadata.
""" """
project: Project! metadata: PackageMetadata
""" """
The package tags. Name of the package.
"""
tags(
"""
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
"""
Returns the last _n_ elements from the list.
"""
last: Int
): PackageTagConnection
"""
The updated date.
"""
updatedAt: Time!
"""
The version of the package.
"""
version: String
"""
The other versions of the package.
"""
versions(
"""
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
"""
Returns the last _n_ elements from the list.
"""
last: Int
): PackageConnection
}
"""
Details of a Composer package
"""
type PackageComposerDetails {
"""
The Composer metadatum.
"""
composerMetadatum: PackageComposerMetadatumType!
"""
The created date.
"""
createdAt: Time!
"""
The ID of the package.
"""
id: ID!
"""
The name of the package.
""" """
name: String! name: String!
""" """
The type of the package. Package type.
""" """
packageType: PackageTypeEnum! packageType: PackageTypeEnum!
...@@ -17050,7 +16950,7 @@ type PackageComposerDetails { ...@@ -17050,7 +16950,7 @@ type PackageComposerDetails {
project: Project! project: Project!
""" """
The package tags. Package tags.
""" """
tags( tags(
""" """
...@@ -17075,12 +16975,12 @@ type PackageComposerDetails { ...@@ -17075,12 +16975,12 @@ type PackageComposerDetails {
): PackageTagConnection ): PackageTagConnection
""" """
The updated date. Date of most recent update.
""" """
updatedAt: Time! updatedAt: Time!
""" """
The version of the package. Version string.
""" """
version: String version: String
...@@ -17107,7 +17007,7 @@ type PackageComposerDetails { ...@@ -17107,7 +17007,7 @@ type PackageComposerDetails {
Returns the last _n_ elements from the list. Returns the last _n_ elements from the list.
""" """
last: Int last: Int
): PackageConnection ): PackageWithoutVersionsConnection
} }
""" """
...@@ -17135,21 +17035,6 @@ type PackageComposerJsonType { ...@@ -17135,21 +17035,6 @@ type PackageComposerJsonType {
version: String version: String
} }
"""
Composer metadatum
"""
type PackageComposerMetadatumType {
"""
Data of the Composer JSON file.
"""
composerJson: PackageComposerJsonType!
"""
Target SHA of the package.
"""
targetSha: String!
}
""" """
The connection type for Package. The connection type for Package.
""" """
...@@ -17265,6 +17150,11 @@ type PackageFileRegistryEdge { ...@@ -17265,6 +17150,11 @@ type PackageFileRegistryEdge {
node: PackageFileRegistry node: PackageFileRegistry
} }
"""
Represents metadata associated with a Package
"""
union PackageMetadata = ComposerMetadata
""" """
Namespace-level Package Registry settings Namespace-level Package Registry settings
""" """
...@@ -17388,6 +17278,136 @@ enum PackageTypeEnum { ...@@ -17388,6 +17278,136 @@ enum PackageTypeEnum {
PYPI PYPI
} }
"""
Represents a version of a package in the Package Registry
"""
type PackageWithoutVersions {
"""
Date of creation.
"""
createdAt: Time!
"""
ID of the package.
"""
id: PackagesPackageID!
"""
Package metadata.
"""
metadata: PackageMetadata
"""
Name of the package.
"""
name: String!
"""
Package type.
"""
packageType: PackageTypeEnum!
"""
Pipelines that built the package.
"""
pipelines(
"""
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
"""
Returns the last _n_ elements from the list.
"""
last: Int
): PipelineConnection
"""
Project where the package is stored.
"""
project: Project!
"""
Package tags.
"""
tags(
"""
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
"""
Returns the last _n_ elements from the list.
"""
last: Int
): PackageTagConnection
"""
Date of most recent update.
"""
updatedAt: Time!
"""
Version string.
"""
version: String
}
"""
The connection type for PackageWithoutVersions.
"""
type PackageWithoutVersionsConnection {
"""
A list of edges.
"""
edges: [PackageWithoutVersionsEdge]
"""
A list of nodes.
"""
nodes: [PackageWithoutVersions]
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
}
"""
An edge in a connection.
"""
type PackageWithoutVersionsEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
"""
The item at the end of the edge.
"""
node: PackageWithoutVersions
}
""" """
Identifier of Packages::Package. Identifier of Packages::Package.
""" """
...@@ -20538,14 +20558,14 @@ type Query { ...@@ -20538,14 +20558,14 @@ type Query {
): Namespace ): Namespace
""" """
Find a composer package Find a package
""" """
packageComposerDetails( package(
""" """
The global ID of the package. The global ID of the package.
""" """
id: PackagesPackageID! id: PackagesPackageID!
): PackageComposerDetails ): Package
""" """
Find a project Find a project
......
doc/api/graphql/reference/gitlab_schema.json
View file @ b97743da
...@@ -10566,6 +10566,55 @@ ...@@ -10566,6 +10566,55 @@
"enumValues": null, "enumValues": null,
"possibleTypes": null "possibleTypes": null
}, },
{
"kind": "OBJECT",
"name": "ComposerMetadata",
"description": "Composer metadata",
"fields": [
{
"name": "composerJson",
"description": "Data of the Composer JSON file.",
"args": [
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PackageComposerJsonType",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "targetSha",
"description": "Target SHA of the package.",
"args": [
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
],
"enumValues": null,
"possibleTypes": null
},
{ {
"kind": "INPUT_OBJECT", "kind": "INPUT_OBJECT",
"name": "ConfigureSastInput", "name": "ConfigureSastInput",
...@@ -49849,7 +49898,7 @@ ...@@ -49849,7 +49898,7 @@
"fields": [ "fields": [
{ {
"name": "createdAt", "name": "createdAt",
"description": "The created date.", "description": "Date of creation.",
"args": [ "args": [
], ],
...@@ -49867,7 +49916,7 @@ ...@@ -49867,7 +49916,7 @@
}, },
{ {
"name": "id", "name": "id",
"description": "The ID of the package.", "description": "ID of the package.",
"args": [ "args": [
], ],
...@@ -49876,16 +49925,30 @@ ...@@ -49876,16 +49925,30 @@
"name": null, "name": null,
"ofType": { "ofType": {
"kind": "SCALAR", "kind": "SCALAR",
"name": "ID", "name": "PackagesPackageID",
"ofType": null "ofType": null
} }
}, },
"isDeprecated": false, "isDeprecated": false,
"deprecationReason": null "deprecationReason": null
}, },
{
"name": "metadata",
"description": "Package metadata.",
"args": [
],
"type": {
"kind": "UNION",
"name": "PackageMetadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{ {
"name": "name", "name": "name",
"description": "The name of the package.", "description": "Name of the package.",
"args": [ "args": [
], ],
...@@ -49903,7 +49966,7 @@ ...@@ -49903,7 +49966,7 @@
}, },
{ {
"name": "packageType", "name": "packageType",
"description": "The type of the package.", "description": "Package type.",
"args": [ "args": [
], ],
...@@ -49992,7 +50055,7 @@ ...@@ -49992,7 +50055,7 @@
}, },
{ {
"name": "tags", "name": "tags",
"description": "The package tags.", "description": "Package tags.",
"args": [ "args": [
{ {
"name": "after", "name": "after",
...@@ -50045,7 +50108,7 @@ ...@@ -50045,7 +50108,7 @@
}, },
{ {
"name": "updatedAt", "name": "updatedAt",
"description": "The updated date.", "description": "Date of most recent update.",
"args": [ "args": [
], ],
...@@ -50063,7 +50126,7 @@ ...@@ -50063,7 +50126,7 @@
}, },
{ {
"name": "version", "name": "version",
"description": "The version of the package.", "description": "Version string.",
"args": [ "args": [
], ],
...@@ -50122,7 +50185,7 @@ ...@@ -50122,7 +50185,7 @@
], ],
"type": { "type": {
"kind": "OBJECT", "kind": "OBJECT",
"name": "PackageConnection", "name": "PackageWithoutVersionsConnection",
"ofType": null "ofType": null
}, },
"isDeprecated": false, "isDeprecated": false,
...@@ -50138,93 +50201,90 @@ ...@@ -50138,93 +50201,90 @@
}, },
{ {
"kind": "OBJECT", "kind": "OBJECT",
"name": "PackageComposerDetails", "name": "PackageComposerJsonType",
"description": "Details of a Composer package", "description": "Represents a composer JSON file",
"fields": [ "fields": [
{ {
"name": "composerMetadatum", "name": "license",
"description": "The Composer metadatum.", "description": "The license set in the Composer JSON file.",
"args": [ "args": [
], ],
"type": { "type": {
"kind": "NON_NULL", "kind": "SCALAR",
"name": null, "name": "String",
"ofType": { "ofType": null
"kind": "OBJECT",
"name": "PackageComposerMetadatumType",
"ofType": null
}
}, },
"isDeprecated": false, "isDeprecated": false,
"deprecationReason": null "deprecationReason": null
}, },
{ {
"name": "createdAt", "name": "name",
"description": "The created date.", "description": "The name set in the Composer JSON file.",
"args": [ "args": [
], ],
"type": { "type": {
"kind": "NON_NULL", "kind": "SCALAR",
"name": null, "name": "String",
"ofType": { "ofType": null
"kind": "SCALAR",
"name": "Time",
"ofType": null
}
}, },
"isDeprecated": false, "isDeprecated": false,
"deprecationReason": null "deprecationReason": null
}, },
{ {
"name": "id", "name": "type",
"description": "The ID of the package.", "description": "The type set in the Composer JSON file.",
"args": [ "args": [
], ],
"type": { "type": {
"kind": "NON_NULL", "kind": "SCALAR",
"name": null, "name": "String",
"ofType": { "ofType": null
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}, },
"isDeprecated": false, "isDeprecated": false,
"deprecationReason": null "deprecationReason": null
}, },
{ {
"name": "name", "name": "version",
"description": "The name of the package.", "description": "The version set in the Composer JSON file.",
"args": [ "args": [
], ],
"type": { "type": {
"kind": "NON_NULL", "kind": "SCALAR",
"name": null, "name": "String",
"ofType": { "ofType": null
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}, },
"isDeprecated": false, "isDeprecated": false,
"deprecationReason": null "deprecationReason": null
}, }
],
"inputFields": null,
"interfaces": [
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PackageConnection",
"description": "The connection type for Package.",
"fields": [
{ {
"name": "packageType", "name": "edges",
"description": "The type of the package.", "description": "A list of edges.",
"args": [ "args": [
], ],
"type": { "type": {
"kind": "NON_NULL", "kind": "LIST",
"name": null, "name": null,
"ofType": { "ofType": {
"kind": "ENUM", "kind": "OBJECT",
"name": "PackageTypeEnum", "name": "PackageEdge",
"ofType": null "ofType": null
} }
}, },
...@@ -50232,61 +50292,26 @@ ...@@ -50232,61 +50292,26 @@
"deprecationReason": null "deprecationReason": null
}, },
{ {
"name": "pipelines", "name": "nodes",
"description": "Pipelines that built the package.", "description": "A list of nodes.",
"args": [ "args": [
{
"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": "OBJECT", "kind": "LIST",
"name": "PipelineConnection", "name": null,
"ofType": null "ofType": {
"kind": "OBJECT",
"name": "Package",
"ofType": null
}
}, },
"isDeprecated": false, "isDeprecated": false,
"deprecationReason": null "deprecationReason": null
}, },
{ {
"name": "project", "name": "pageInfo",
"description": "Project where the package is stored.", "description": "Information to aid in pagination.",
"args": [ "args": [
], ],
...@@ -50295,69 +50320,29 @@ ...@@ -50295,69 +50320,29 @@
"name": null, "name": null,
"ofType": { "ofType": {
"kind": "OBJECT", "kind": "OBJECT",
"name": "Project", "name": "PageInfo",
"ofType": null "ofType": null
} }
}, },
"isDeprecated": false, "isDeprecated": false,
"deprecationReason": null "deprecationReason": null
}, }
{ ],
"name": "tags", "inputFields": null,
"description": "The package tags.", "interfaces": [
"args": [
{ ],
"name": "after", "enumValues": null,
"description": "Returns the elements in the list that come after the specified cursor.", "possibleTypes": null
"type": { },
"kind": "SCALAR", {
"name": "String", "kind": "OBJECT",
"ofType": null "name": "PackageEdge",
}, "description": "An edge in a connection.",
"defaultValue": null "fields": [
},
{
"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": "PackageTagConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{ {
"name": "updatedAt", "name": "cursor",
"description": "The updated date.", "description": "A cursor for use in pagination.",
"args": [ "args": [
], ],
...@@ -50366,7 +50351,7 @@ ...@@ -50366,7 +50351,7 @@
"name": null, "name": null,
"ofType": { "ofType": {
"kind": "SCALAR", "kind": "SCALAR",
"name": "Time", "name": "String",
"ofType": null "ofType": null
} }
}, },
...@@ -50374,67 +50359,14 @@ ...@@ -50374,67 +50359,14 @@
"deprecationReason": null "deprecationReason": null
}, },
{ {
"name": "version", "name": "node",
"description": "The version of the package.", "description": "The item at the end of the edge.",
"args": [ "args": [
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "versions",
"description": "The other versions of the package.",
"args": [
{
"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": "OBJECT", "kind": "OBJECT",
"name": "PackageConnection", "name": "Package",
"ofType": null "ofType": null
}, },
"isDeprecated": false, "isDeprecated": false,
...@@ -50450,40 +50382,44 @@ ...@@ -50450,40 +50382,44 @@
}, },
{ {
"kind": "OBJECT", "kind": "OBJECT",
"name": "PackageComposerJsonType", "name": "PackageFileRegistry",
"description": "Represents a composer JSON file", "description": "Represents the Geo sync and verification state of a package file",
"fields": [ "fields": [
{ {
"name": "license", "name": "createdAt",
"description": "The license set in the Composer JSON file.", "description": "Timestamp when the PackageFileRegistry was created",
"args": [ "args": [
], ],
"type": { "type": {
"kind": "SCALAR", "kind": "SCALAR",
"name": "String", "name": "Time",
"ofType": null "ofType": null
}, },
"isDeprecated": false, "isDeprecated": false,
"deprecationReason": null "deprecationReason": null
}, },
{ {
"name": "name", "name": "id",
"description": "The name set in the Composer JSON file.", "description": "ID of the PackageFileRegistry",
"args": [ "args": [
], ],
"type": { "type": {
"kind": "SCALAR", "kind": "NON_NULL",
"name": "String", "name": null,
"ofType": null "ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}, },
"isDeprecated": false, "isDeprecated": false,
"deprecationReason": null "deprecationReason": null
}, },
{ {
"name": "type", "name": "lastSyncFailure",
"description": "The type set in the Composer JSON file.", "description": "Error message during sync of the PackageFileRegistry",
"args": [ "args": [
], ],
...@@ -50496,35 +50432,22 @@ ...@@ -50496,35 +50432,22 @@
"deprecationReason": null "deprecationReason": null
}, },
{ {
"name": "version", "name": "lastSyncedAt",
"description": "The version set in the Composer JSON file.", "description": "Timestamp of the most recent successful sync of the PackageFileRegistry",
"args": [ "args": [
], ],
"type": { "type": {
"kind": "SCALAR", "kind": "SCALAR",
"name": "String", "name": "Time",
"ofType": null "ofType": null
}, },
"isDeprecated": false, "isDeprecated": false,
"deprecationReason": null "deprecationReason": null
} },
],
"inputFields": null,
"interfaces": [
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PackageComposerMetadatumType",
"description": "Composer metadatum",
"fields": [
{ {
"name": "composerJson", "name": "packageFileId",
"description": "Data of the Composer JSON file.", "description": "ID of the PackageFile",
"args": [ "args": [
], ],
...@@ -50532,8 +50455,8 @@ ...@@ -50532,8 +50455,8 @@
"kind": "NON_NULL", "kind": "NON_NULL",
"name": null, "name": null,
"ofType": { "ofType": {
"kind": "OBJECT", "kind": "SCALAR",
"name": "PackageComposerJsonType", "name": "ID",
"ofType": null "ofType": null
} }
}, },
...@@ -50541,19 +50464,43 @@ ...@@ -50541,19 +50464,43 @@
"deprecationReason": null "deprecationReason": null
}, },
{ {
"name": "targetSha", "name": "retryAt",
"description": "Target SHA of the package.", "description": "Timestamp after which the PackageFileRegistry should be resynced",
"args": [ "args": [
], ],
"type": { "type": {
"kind": "NON_NULL", "kind": "SCALAR",
"name": null, "name": "Time",
"ofType": { "ofType": null
"kind": "SCALAR", },
"name": "String", "isDeprecated": false,
"ofType": null "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, "isDeprecated": false,
"deprecationReason": null "deprecationReason": null
...@@ -50568,8 +50515,8 @@ ...@@ -50568,8 +50515,8 @@
}, },
{ {
"kind": "OBJECT", "kind": "OBJECT",
"name": "PackageConnection", "name": "PackageFileRegistryConnection",
"description": "The connection type for Package.", "description": "The connection type for PackageFileRegistry.",
"fields": [ "fields": [
{ {
"name": "edges", "name": "edges",
...@@ -50582,7 +50529,7 @@ ...@@ -50582,7 +50529,7 @@
"name": null, "name": null,
"ofType": { "ofType": {
"kind": "OBJECT", "kind": "OBJECT",
"name": "PackageEdge", "name": "PackageFileRegistryEdge",
"ofType": null "ofType": null
} }
}, },
...@@ -50600,7 +50547,7 @@ ...@@ -50600,7 +50547,7 @@
"name": null, "name": null,
"ofType": { "ofType": {
"kind": "OBJECT", "kind": "OBJECT",
"name": "Package", "name": "PackageFileRegistry",
"ofType": null "ofType": null
} }
}, },
...@@ -50635,7 +50582,7 @@ ...@@ -50635,7 +50582,7 @@
}, },
{ {
"kind": "OBJECT", "kind": "OBJECT",
"name": "PackageEdge", "name": "PackageFileRegistryEdge",
"description": "An edge in a connection.", "description": "An edge in a connection.",
"fields": [ "fields": [
{ {
...@@ -50664,7 +50611,7 @@ ...@@ -50664,7 +50611,7 @@
], ],
"type": { "type": {
"kind": "OBJECT", "kind": "OBJECT",
"name": "Package", "name": "PackageFileRegistry",
"ofType": null "ofType": null
}, },
"isDeprecated": false, "isDeprecated": false,
...@@ -50678,28 +50625,44 @@ ...@@ -50678,28 +50625,44 @@
"enumValues": null, "enumValues": null,
"possibleTypes": null "possibleTypes": null
}, },
{
"kind": "UNION",
"name": "PackageMetadata",
"description": "Represents metadata associated with a Package",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "ComposerMetadata",
"ofType": null
}
]
},
{ {
"kind": "OBJECT", "kind": "OBJECT",
"name": "PackageFileRegistry", "name": "PackageSettings",
"description": "Represents the Geo sync and verification state of a package file", "description": "Namespace-level Package Registry settings",
"fields": [ "fields": [
{ {
"name": "createdAt", "name": "mavenDuplicateExceptionRegex",
"description": "Timestamp when the PackageFileRegistry was created", "description": "When maven_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect.",
"args": [ "args": [
], ],
"type": { "type": {
"kind": "SCALAR", "kind": "SCALAR",
"name": "Time", "name": "UntrustedRegexp",
"ofType": null "ofType": null
}, },
"isDeprecated": false, "isDeprecated": false,
"deprecationReason": null "deprecationReason": null
}, },
{ {
"name": "id", "name": "mavenDuplicatesAllowed",
"description": "ID of the PackageFileRegistry", "description": "Indicates whether duplicate Maven packages are allowed for this namespace.",
"args": [ "args": [
], ],
...@@ -50708,44 +50671,47 @@ ...@@ -50708,44 +50671,47 @@
"name": null, "name": null,
"ofType": { "ofType": {
"kind": "SCALAR", "kind": "SCALAR",
"name": "ID", "name": "Boolean",
"ofType": null "ofType": null
} }
}, },
"isDeprecated": false, "isDeprecated": false,
"deprecationReason": null "deprecationReason": null
}, }
{ ],
"name": "lastSyncFailure", "inputFields": null,
"description": "Error message during sync of the PackageFileRegistry", "interfaces": [
"args": [
], ],
"type": { "enumValues": null,
"kind": "SCALAR", "possibleTypes": null
"name": "String", },
"ofType": null {
}, "kind": "OBJECT",
"isDeprecated": false, "name": "PackageTag",
"deprecationReason": null "description": "Represents a package tag",
}, "fields": [
{ {
"name": "lastSyncedAt", "name": "createdAt",
"description": "Timestamp of the most recent successful sync of the PackageFileRegistry", "description": "The created date.",
"args": [ "args": [
], ],
"type": { "type": {
"kind": "SCALAR", "kind": "NON_NULL",
"name": "Time", "name": null,
"ofType": null "ofType": {
"kind": "SCALAR",
"name": "Time",
"ofType": null
}
}, },
"isDeprecated": false, "isDeprecated": false,
"deprecationReason": null "deprecationReason": null
}, },
{ {
"name": "packageFileId", "name": "id",
"description": "ID of the PackageFile", "description": "The ID of the tag.",
"args": [ "args": [
], ],
...@@ -50762,43 +50728,37 @@ ...@@ -50762,43 +50728,37 @@
"deprecationReason": null "deprecationReason": null
}, },
{ {
"name": "retryAt", "name": "name",
"description": "Timestamp after which the PackageFileRegistry should be resynced", "description": "The name of the tag.",
"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": [ "args": [
], ],
"type": { "type": {
"kind": "SCALAR", "kind": "NON_NULL",
"name": "Int", "name": null,
"ofType": null "ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}, },
"isDeprecated": false, "isDeprecated": false,
"deprecationReason": null "deprecationReason": null
}, },
{ {
"name": "state", "name": "updatedAt",
"description": "Sync state of the PackageFileRegistry", "description": "The updated date.",
"args": [ "args": [
], ],
"type": { "type": {
"kind": "ENUM", "kind": "NON_NULL",
"name": "RegistryState", "name": null,
"ofType": null "ofType": {
"kind": "SCALAR",
"name": "Time",
"ofType": null
}
}, },
"isDeprecated": false, "isDeprecated": false,
"deprecationReason": null "deprecationReason": null
...@@ -50813,8 +50773,8 @@ ...@@ -50813,8 +50773,8 @@
}, },
{ {
"kind": "OBJECT", "kind": "OBJECT",
"name": "PackageFileRegistryConnection", "name": "PackageTagConnection",
"description": "The connection type for PackageFileRegistry.", "description": "The connection type for PackageTag.",
"fields": [ "fields": [
{ {
"name": "edges", "name": "edges",
...@@ -50827,7 +50787,7 @@ ...@@ -50827,7 +50787,7 @@
"name": null, "name": null,
"ofType": { "ofType": {
"kind": "OBJECT", "kind": "OBJECT",
"name": "PackageFileRegistryEdge", "name": "PackageTagEdge",
"ofType": null "ofType": null
} }
}, },
...@@ -50845,7 +50805,7 @@ ...@@ -50845,7 +50805,7 @@
"name": null, "name": null,
"ofType": { "ofType": {
"kind": "OBJECT", "kind": "OBJECT",
"name": "PackageFileRegistry", "name": "PackageTag",
"ofType": null "ofType": null
} }
}, },
...@@ -50880,7 +50840,7 @@ ...@@ -50880,7 +50840,7 @@
}, },
{ {
"kind": "OBJECT", "kind": "OBJECT",
"name": "PackageFileRegistryEdge", "name": "PackageTagEdge",
"description": "An edge in a connection.", "description": "An edge in a connection.",
"fields": [ "fields": [
{ {
...@@ -50909,7 +50869,7 @@ ...@@ -50909,7 +50869,7 @@
], ],
"type": { "type": {
"kind": "OBJECT", "kind": "OBJECT",
"name": "PackageFileRegistry", "name": "PackageTag",
"ofType": null "ofType": null
}, },
"isDeprecated": false, "isDeprecated": false,
...@@ -50923,28 +50883,97 @@ ...@@ -50923,28 +50883,97 @@
"enumValues": null, "enumValues": null,
"possibleTypes": null "possibleTypes": null
}, },
{
"kind": "ENUM",
"name": "PackageTypeEnum",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "MAVEN",
"description": "Packages from the Maven package manager",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NPM",
"description": "Packages from the NPM package manager",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CONAN",
"description": "Packages from the Conan package manager",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NUGET",
"description": "Packages from the Nuget package manager",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PYPI",
"description": "Packages from the PyPI package manager",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "COMPOSER",
"description": "Packages from the Composer package manager",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GENERIC",
"description": "Packages from the Generic package manager",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GOLANG",
"description": "Packages from the Golang package manager",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DEBIAN",
"description": "Packages from the Debian package manager",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{ {
"kind": "OBJECT", "kind": "OBJECT",
"name": "PackageSettings", "name": "PackageWithoutVersions",
"description": "Namespace-level Package Registry settings", "description": "Represents a version of a package in the Package Registry",
"fields": [ "fields": [
{ {
"name": "mavenDuplicateExceptionRegex", "name": "createdAt",
"description": "When maven_duplicates_allowed is false, you can publish duplicate packages with names that match this regex. Otherwise, this setting has no effect.", "description": "Date of creation.",
"args": [ "args": [
], ],
"type": { "type": {
"kind": "SCALAR", "kind": "NON_NULL",
"name": "UntrustedRegexp", "name": null,
"ofType": null "ofType": {
"kind": "SCALAR",
"name": "Time",
"ofType": null
}
}, },
"isDeprecated": false, "isDeprecated": false,
"deprecationReason": null "deprecationReason": null
}, },
{ {
"name": "mavenDuplicatesAllowed", "name": "id",
"description": "Indicates whether duplicate Maven packages are allowed for this namespace.", "description": "ID of the package.",
"args": [ "args": [
], ],
...@@ -50953,29 +50982,30 @@ ...@@ -50953,29 +50982,30 @@
"name": null, "name": null,
"ofType": { "ofType": {
"kind": "SCALAR", "kind": "SCALAR",
"name": "Boolean", "name": "PackagesPackageID",
"ofType": null "ofType": null
} }
}, },
"isDeprecated": false, "isDeprecated": false,
"deprecationReason": null "deprecationReason": null
} },
], {
"inputFields": null, "name": "metadata",
"interfaces": [ "description": "Package metadata.",
"args": [
], ],
"enumValues": null, "type": {
"possibleTypes": null "kind": "UNION",
}, "name": "PackageMetadata",
{ "ofType": null
"kind": "OBJECT", },
"name": "PackageTag", "isDeprecated": false,
"description": "Represents a package tag", "deprecationReason": null
"fields": [ },
{ {
"name": "createdAt", "name": "name",
"description": "The created date.", "description": "Name of the package.",
"args": [ "args": [
], ],
...@@ -50984,7 +51014,7 @@ ...@@ -50984,7 +51014,7 @@
"name": null, "name": null,
"ofType": { "ofType": {
"kind": "SCALAR", "kind": "SCALAR",
"name": "Time", "name": "String",
"ofType": null "ofType": null
} }
}, },
...@@ -50992,8 +51022,8 @@ ...@@ -50992,8 +51022,8 @@
"deprecationReason": null "deprecationReason": null
}, },
{ {
"name": "id", "name": "packageType",
"description": "The ID of the tag.", "description": "Package type.",
"args": [ "args": [
], ],
...@@ -51001,8 +51031,8 @@ ...@@ -51001,8 +51031,8 @@
"kind": "NON_NULL", "kind": "NON_NULL",
"name": null, "name": null,
"ofType": { "ofType": {
"kind": "SCALAR", "kind": "ENUM",
"name": "ID", "name": "PackageTypeEnum",
"ofType": null "ofType": null
} }
}, },
...@@ -51010,8 +51040,61 @@ ...@@ -51010,8 +51040,61 @@
"deprecationReason": null "deprecationReason": null
}, },
{ {
"name": "name", "name": "pipelines",
"description": "The name of the tag.", "description": "Pipelines that built the package.",
"args": [
{
"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": "PipelineConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "project",
"description": "Project where the package is stored.",
"args": [ "args": [
], ],
...@@ -51019,17 +51102,70 @@ ...@@ -51019,17 +51102,70 @@
"kind": "NON_NULL", "kind": "NON_NULL",
"name": null, "name": null,
"ofType": { "ofType": {
"kind": "SCALAR", "kind": "OBJECT",
"name": "String", "name": "Project",
"ofType": null "ofType": null
} }
}, },
"isDeprecated": false, "isDeprecated": false,
"deprecationReason": null "deprecationReason": null
}, },
{
"name": "tags",
"description": "Package tags.",
"args": [
{
"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": "PackageTagConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{ {
"name": "updatedAt", "name": "updatedAt",
"description": "The updated date.", "description": "Date of most recent update.",
"args": [ "args": [
], ],
...@@ -51044,6 +51180,20 @@ ...@@ -51044,6 +51180,20 @@
}, },
"isDeprecated": false, "isDeprecated": false,
"deprecationReason": null "deprecationReason": null
},
{
"name": "version",
"description": "Version string.",
"args": [
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
} }
], ],
"inputFields": null, "inputFields": null,
...@@ -51055,8 +51205,8 @@ ...@@ -51055,8 +51205,8 @@
}, },
{ {
"kind": "OBJECT", "kind": "OBJECT",
"name": "PackageTagConnection", "name": "PackageWithoutVersionsConnection",
"description": "The connection type for PackageTag.", "description": "The connection type for PackageWithoutVersions.",
"fields": [ "fields": [
{ {
"name": "edges", "name": "edges",
...@@ -51069,7 +51219,7 @@ ...@@ -51069,7 +51219,7 @@
"name": null, "name": null,
"ofType": { "ofType": {
"kind": "OBJECT", "kind": "OBJECT",
"name": "PackageTagEdge", "name": "PackageWithoutVersionsEdge",
"ofType": null "ofType": null
} }
}, },
...@@ -51087,7 +51237,7 @@ ...@@ -51087,7 +51237,7 @@
"name": null, "name": null,
"ofType": { "ofType": {
"kind": "OBJECT", "kind": "OBJECT",
"name": "PackageTag", "name": "PackageWithoutVersions",
"ofType": null "ofType": null
} }
}, },
...@@ -51122,7 +51272,7 @@ ...@@ -51122,7 +51272,7 @@
}, },
{ {
"kind": "OBJECT", "kind": "OBJECT",
"name": "PackageTagEdge", "name": "PackageWithoutVersionsEdge",
"description": "An edge in a connection.", "description": "An edge in a connection.",
"fields": [ "fields": [
{ {
...@@ -51151,7 +51301,7 @@ ...@@ -51151,7 +51301,7 @@
], ],
"type": { "type": {
"kind": "OBJECT", "kind": "OBJECT",
"name": "PackageTag", "name": "PackageWithoutVersions",
"ofType": null "ofType": null
}, },
"isDeprecated": false, "isDeprecated": false,
...@@ -51165,71 +51315,6 @@ ...@@ -51165,71 +51315,6 @@
"enumValues": null, "enumValues": null,
"possibleTypes": null "possibleTypes": null
}, },
{
"kind": "ENUM",
"name": "PackageTypeEnum",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "MAVEN",
"description": "Packages from the Maven package manager",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NPM",
"description": "Packages from the NPM package manager",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CONAN",
"description": "Packages from the Conan package manager",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NUGET",
"description": "Packages from the Nuget package manager",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PYPI",
"description": "Packages from the PyPI package manager",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "COMPOSER",
"description": "Packages from the Composer package manager",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GENERIC",
"description": "Packages from the Generic package manager",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GOLANG",
"description": "Packages from the Golang package manager",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DEBIAN",
"description": "Packages from the Debian package manager",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{ {
"kind": "SCALAR", "kind": "SCALAR",
"name": "PackagesPackageID", "name": "PackagesPackageID",
...@@ -59703,8 +59788,8 @@ ...@@ -59703,8 +59788,8 @@
"deprecationReason": null "deprecationReason": null
}, },
{ {
"name": "packageComposerDetails", "name": "package",
"description": "Find a composer package", "description": "Find a package",
"args": [ "args": [
{ {
"name": "id", "name": "id",
...@@ -59723,7 +59808,7 @@ ...@@ -59723,7 +59808,7 @@
], ],
"type": { "type": {
"kind": "OBJECT", "kind": "OBJECT",
"name": "PackageComposerDetails", "name": "Package",
"ofType": null "ofType": null
}, },
"isDeprecated": false, "isDeprecated": false,
doc/api/graphql/reference/index.md
View file @ b97743da
...@@ -593,6 +593,15 @@ Represents a ComplianceFramework associated with a Project. ...@@ -593,6 +593,15 @@ Represents a ComplianceFramework associated with a Project.
| `name` | String! | Name of the compliance framework | | `name` | String! | Name of the compliance framework |
| `pipelineConfigurationFullPath` | String | Full path of the compliance pipeline configuration stored in a project repository, such as `.gitlab/compliance/soc2/.gitlab-ci.yml`. | | `pipelineConfigurationFullPath` | String | Full path of the compliance pipeline configuration stored in a project repository, such as `.gitlab/compliance/soc2/.gitlab-ci.yml`. |
### ComposerMetadata
Composer metadata.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `composerJson` | PackageComposerJsonType! | Data of the Composer JSON file. |
| `targetSha` | String! | Target SHA of the package. |
### ConfigureSastPayload ### ConfigureSastPayload
Autogenerated return type of ConfigureSast. Autogenerated return type of ConfigureSast.
...@@ -2541,34 +2550,17 @@ Represents a package in the Package Registry. ...@@ -2541,34 +2550,17 @@ Represents a package in the Package Registry.
| Field | Type | Description | | Field | Type | Description |
| ----- | ---- | ----------- | | ----- | ---- | ----------- |
| `createdAt` | Time! | The created date. | | `createdAt` | Time! | Date of creation. |
| `id` | ID! | The ID of the package. | | `id` | PackagesPackageID! | ID of the package. |
| `name` | String! | The name of the package. | | `metadata` | PackageMetadata | Package metadata. |
| `packageType` | PackageTypeEnum! | The type of the package. | | `name` | String! | Name of the package. |
| `pipelines` | PipelineConnection | Pipelines that built the package. | | `packageType` | PackageTypeEnum! | Package type. |
| `project` | Project! | Project where the package is stored. |
| `tags` | PackageTagConnection | The package tags. |
| `updatedAt` | Time! | The updated date. |
| `version` | String | The version of the package. |
| `versions` | PackageConnection | The other versions of the package. |
### PackageComposerDetails
Details of a Composer package.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `composerMetadatum` | PackageComposerMetadatumType! | The Composer metadatum. |
| `createdAt` | Time! | The created date. |
| `id` | ID! | The ID of the package. |
| `name` | String! | The name of the package. |
| `packageType` | PackageTypeEnum! | The type of the package. |
| `pipelines` | PipelineConnection | Pipelines that built the package. | | `pipelines` | PipelineConnection | Pipelines that built the package. |
| `project` | Project! | Project where the package is stored. | | `project` | Project! | Project where the package is stored. |
| `tags` | PackageTagConnection | The package tags. | | `tags` | PackageTagConnection | Package tags. |
| `updatedAt` | Time! | The updated date. | | `updatedAt` | Time! | Date of most recent update. |
| `version` | String | The version of the package. | | `version` | String | Version string. |
| `versions` | PackageConnection | The other versions of the package. | | `versions` | PackageWithoutVersionsConnection | The other versions of the package. |
### PackageComposerJsonType ### PackageComposerJsonType
...@@ -2581,15 +2573,6 @@ Represents a composer JSON file. ...@@ -2581,15 +2573,6 @@ Represents a composer JSON file.
| `type` | String | The type set in the Composer JSON file. | | `type` | String | The type set in the Composer JSON file. |
| `version` | String | The version set in the Composer JSON file. | | `version` | String | The version set in the Composer JSON file. |
### PackageComposerMetadatumType
Composer metadatum.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `composerJson` | PackageComposerJsonType! | Data of the Composer JSON file. |
| `targetSha` | String! | Target SHA of the package. |
### PackageFileRegistry ### PackageFileRegistry
Represents the Geo sync and verification state of a package file. Represents the Geo sync and verification state of a package file.
...@@ -2625,6 +2608,23 @@ Represents a package tag. ...@@ -2625,6 +2608,23 @@ Represents a package tag.
| `name` | String! | The name of the tag. | | `name` | String! | The name of the tag. |
| `updatedAt` | Time! | The updated date. | | `updatedAt` | Time! | The updated date. |
### PackageWithoutVersions
Represents a version of a package in the Package Registry.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `createdAt` | Time! | Date of creation. |
| `id` | PackagesPackageID! | ID of the package. |
| `metadata` | PackageMetadata | Package metadata. |
| `name` | String! | Name of the package. |
| `packageType` | PackageTypeEnum! | Package type. |
| `pipelines` | PipelineConnection | Pipelines that built the package. |
| `project` | Project! | Project where the package is stored. |
| `tags` | PackageTagConnection | Package tags. |
| `updatedAt` | Time! | Date of most recent update. |
| `version` | String | Version string. |
### PageInfo ### PageInfo
Information about pagination in a connection.. 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