Skip to content

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

Update GraphQL documentation

parent 671d5b51
Expand all 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/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