From 45a8c43afe8a17de19a92708b380b29b6ae04ce6 Mon Sep 17 00:00:00 2001 From: GitLab Bot Date: Mon, 15 May 2023 09:08:57 +0000 Subject: Add latest changes from gitlab-org/gitlab@master --- doc/api/graphql/reference/index.md | 120 ++++++++++++++++++++++++++++--------- doc/api/packages.md | 65 ++++++++++++++------ 2 files changed, 141 insertions(+), 44 deletions(-) (limited to 'doc/api') diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index 50d48a7242f..e3abed66d77 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -1785,6 +1785,10 @@ Input type: `CreateAlertIssueInput` ### `Mutation.createAnnotation` +WARNING: +**Deprecated** in 16.0. +Underlying feature was removed in 16.0. + Input type: `CreateAnnotationInput` #### Arguments @@ -2593,6 +2597,10 @@ Input type: `DastSiteValidationRevokeInput` ### `Mutation.deleteAnnotation` +WARNING: +**Deprecated** in 16.0. +Underlying feature was removed in 16.0. + Input type: `DeleteAnnotationInput` #### Arguments @@ -12784,7 +12792,60 @@ four standard [pagination arguments](#connection-pagination-arguments): | Name | Type | Description | | ---- | ---- | ----------- | | `names` | [`[String!]`](#string) | Names of the commit parent (branch or tag). | -| `totalCount` | [`Int`](#int) | Total of parent branches or tags. | + +### `CommitReferences` + +#### Fields with arguments + +##### `CommitReferences.containingBranches` + +Get branch names containing a given commit. + +Returns [`CommitParentNames`](#commitparentnames). + +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `excludeTipped` | [`Boolean!`](#boolean) | Exclude tipping refs. WARNING: This argument can be confusing, if there is a limit. for example set the limit to 5 and in the 5 out a total of 25 refs there is 2 tipped refs, then the method will only 3 refs, even though there is more. | +| `limit` | [`Int!`](#int) | Number of ref names to return. | + +##### `CommitReferences.containingTags` + +Get tag names containing a given commit. + +Returns [`CommitParentNames`](#commitparentnames). + +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `excludeTipped` | [`Boolean!`](#boolean) | Exclude tipping refs. WARNING: This argument can be confusing, if there is a limit. for example set the limit to 5 and in the 5 out a total of 25 refs there is 2 tipped refs, then the method will only 3 refs, even though there is more. | +| `limit` | [`Int!`](#int) | Number of ref names to return. | + +##### `CommitReferences.tippingBranches` + +Get branch names tipping at a given commit. + +Returns [`CommitParentNames`](#commitparentnames). + +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `limit` | [`Int!`](#int) | Number of ref names to return. | + +##### `CommitReferences.tippingTags` + +Get tag names tipping at a given commit. + +Returns [`CommitParentNames`](#commitparentnames). + +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `limit` | [`Int!`](#int) | Number of ref names to return. | ### `ComplianceFramework` @@ -16346,6 +16407,7 @@ Check permissions for the current user on a issue. | `readDesign` | [`Boolean!`](#boolean) | Indicates the user can perform `read_design` on this resource. | | `readIssue` | [`Boolean!`](#boolean) | Indicates the user can perform `read_issue` on this resource. | | `reopenIssue` | [`Boolean!`](#boolean) | Indicates the user can perform `reopen_issue` on this resource. | +| `updateDesign` | [`Boolean!`](#boolean) | Indicates the user can perform `update_design` on this resource. | | `updateIssue` | [`Boolean!`](#boolean) | Indicates the user can perform `update_issue` on this resource. | ### `IssueStatusCountsType` @@ -19046,6 +19108,7 @@ Represents a product analytics dashboard visualization. | `sshUrlToRepo` | [`String`](#string) | URL to connect to the project via SSH. | | `starCount` | [`Int!`](#int) | Number of times the project has been starred. | | `statistics` | [`ProjectStatistics`](#projectstatistics) | Statistics of the project. | +| `statisticsDetailsPaths` | [`ProjectStatisticsRedirect`](#projectstatisticsredirect) | Redirects for Statistics of the project. | | `suggestionCommitMessage` | [`String`](#string) | Commit message used to apply merge request suggestions. | | `tagList` **{warning-solid}** | [`String`](#string) | **Deprecated** in 13.12. Use `topics`. | | `terraformStates` | [`TerraformStateConnection`](#terraformstateconnection) | Terraform states associated with the project. (see [Connections](#connections)) | @@ -19185,19 +19248,6 @@ four standard [pagination arguments](#connection-pagination-arguments): | ---- | ---- | ----------- | | `id` | [`BoardID`](#boardid) | Find a board by its ID. | -##### `Project.branchesTippingAtCommit` - -Get branch names tipping at a given commit. - -Returns [`CommitParentNames`](#commitparentnames). - -###### Arguments - -| Name | Type | Description | -| ---- | ---- | ----------- | -| `commitSha` | [`String!`](#string) | Project commit SHA identifier. For example, `287774414568010855642518513f085491644061`. | -| `limit` | [`Int`](#int) | Number of branch names to return. | - ##### `Project.ciConfigVariables` CI/CD config variable. @@ -19273,6 +19323,22 @@ four standard [pagination arguments](#connection-pagination-arguments): | `hasRemoteDevelopmentAgentConfig` | [`Boolean`](#boolean) | Returns only cluster agents which have an associated remote development agent config. | | `hasVulnerabilities` | [`Boolean`](#boolean) | Returns only cluster agents which have vulnerabilities. | +##### `Project.commitReferences` + +Get tag names containing a given commit. + +WARNING: +**Introduced** in 16.0. +This feature is an Experiment. It can be changed or removed at any time. + +Returns [`CommitReferences`](#commitreferences). + +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `commitSha` | [`String!`](#string) | Project commit SHA identifier. For example, `287774414568010855642518513f085491644061`. | + ##### `Project.containerRepositories` Container repositories of the project. @@ -20228,19 +20294,6 @@ four standard [pagination arguments](#connection-pagination-arguments): | `ids` | [`[SnippetID!]`](#snippetid) | Array of global snippet IDs. For example, `gid://gitlab/ProjectSnippet/1`. | | `visibility` | [`VisibilityScopesEnum`](#visibilityscopesenum) | Visibility of the snippet. | -##### `Project.tagsTippingAtCommit` - -Get tag names tipping at a given commit. - -Returns [`CommitParentNames`](#commitparentnames). - -###### Arguments - -| Name | Type | Description | -| ---- | ---- | ----------- | -| `commitSha` | [`String!`](#string) | Project commit SHA identifier. For example, `287774414568010855642518513f085491644061`. | -| `limit` | [`Int`](#int) | Number of branch names to return. | - ##### `Project.terraformState` Find a single Terraform state by name. @@ -20561,6 +20614,19 @@ Represents the source of a security policy belonging to a project. | `uploadsSize` | [`Float`](#float) | Uploads size of the project in bytes. | | `wikiSize` | [`Float`](#float) | Wiki size of the project in bytes. | +### `ProjectStatisticsRedirect` + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `buildArtifacts` | [`String!`](#string) | Redirection Route for job_artifacts. | +| `containerRegistry` | [`String!`](#string) | Redirection Route for container_registry. | +| `packages` | [`String!`](#string) | Redirection Route for packages. | +| `repository` | [`String!`](#string) | Redirection Route for repository. | +| `snippets` | [`String!`](#string) | Redirection Route for snippets. | +| `wiki` | [`String!`](#string) | Redirection Route for wiki. | + ### `ProjectValueStreamAnalyticsFlowMetrics` Exposes aggregated value stream flow metrics. diff --git a/doc/api/packages.md b/doc/api/packages.md index 58026f5e25f..86eaf3028cf 100644 --- a/doc/api/packages.md +++ b/doc/api/packages.md @@ -37,12 +37,6 @@ GET /projects/:id/packages curl --header "PRIVATE-TOKEN: " "https://gitlab.example.com/api/v4/projects/:id/packages" ``` -> **Deprecation:** -> -> The `pipelines` attribute in the response is deprecated in favor of the package pipelines endpoint, which was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/341950) in GitLab 16.0. The `pipelines` attribute always returns an empty array if the feature flag is enabled. -> The `pipeline` attribute in the response is deprecated in favor of `pipelines`, which was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/44348) in GitLab 13.6. Both are available until 13.7. -> The `build_info` attribute in the response is deprecated in favor of `pipeline`, which was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28040) in GitLab 12.10. - Example response: ```json @@ -52,16 +46,14 @@ Example response: "name": "com/mycompany/my-app", "version": "1.0-SNAPSHOT", "package_type": "maven", - "created_at": "2019-11-27T03:37:38.711Z", - "pipelines": [] + "created_at": "2019-11-27T03:37:38.711Z" }, { "id": 2, "name": "@foo/bar", "version": "1.0.3", "package_type": "npm", - "created_at": "2019-11-27T03:37:38.711Z", - "pipelines": [] + "created_at": "2019-11-27T03:37:38.711Z" }, { "id": 3, @@ -74,8 +66,7 @@ Example response: "delete_api_path": "https://gitlab.example.com/api/v4/projects/1/packages/3" }, "created_at": "2029-12-16T20:33:34.316Z", - "tags": [], - "pipelines": [] + "tags": [] } ] ``` @@ -115,7 +106,6 @@ curl --header "PRIVATE-TOKEN: " "https://gitlab.example.com/a > **Deprecation:** > -> The `pipelines` attribute in the response is deprecated in favor of the package pipelines endpoint, which was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/341950) in GitLab 16.0. The `pipelines` attribute always returns an empty array if the feature flag is enabled. > The `pipeline` attribute in the response is deprecated in favor of `pipelines`, which was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/44348) in GitLab 13.6. Both are available until 13.7. > The `build_info` attribute in the response is deprecated in favor of `pipeline`, which was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28040) in GitLab 12.10. @@ -133,7 +123,21 @@ Example response: "delete_api_path": "/namespace1/project1/-/packages/1" }, "created_at": "2019-11-27T03:37:38.711Z", - "pipelines": [] + "pipelines": [ + { + "id": 123, + "status": "pending", + "ref": "new-pipeline", + "sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a", + "web_url": "https://example.com/foo/bar/pipelines/47", + "created_at": "2016-08-11T11:28:34.085Z", + "updated_at": "2016-08-11T11:32:35.169Z", + "user": { + "name": "Administrator", + "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon" + } + } + ] }, { "id": 2, @@ -145,7 +149,21 @@ Example response: "delete_api_path": "/namespace1/project1/-/packages/1" }, "created_at": "2019-11-27T03:37:38.711Z", - "pipelines": [] + "pipelines": [ + { + "id": 123, + "status": "pending", + "ref": "new-pipeline", + "sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a", + "web_url": "https://example.com/foo/bar/pipelines/47", + "created_at": "2016-08-11T11:28:34.085Z", + "updated_at": "2016-08-11T11:32:35.169Z", + "user": { + "name": "Administrator", + "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon" + } + } + ] } ] ``` @@ -179,7 +197,6 @@ curl --header "PRIVATE-TOKEN: " "https://gitlab.example.com/a > **Deprecation:** > -> The `pipelines` attribute in the response is deprecated in favor of the package pipelines endpoint, which was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/341950) in GitLab 16.0. The `pipelines` attribute always returns an empty array if the feature flag is enabled. > The `pipeline` attribute in the response is deprecated in favor of `pipelines`, which was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/44348) in GitLab 13.6. Both are available until 13.7. > The `build_info` attribute in the response is deprecated in favor of `pipeline`, which was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28040) in GitLab 12.10. @@ -197,7 +214,21 @@ Example response: }, "created_at": "2019-11-27T03:37:38.711Z", "last_downloaded_at": "2022-09-07T07:51:50.504Z" - "pipelines": [], + "pipelines": [ + { + "id": 123, + "status": "pending", + "ref": "new-pipeline", + "sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a", + "web_url": "https://example.com/foo/bar/pipelines/47", + "created_at": "2016-08-11T11:28:34.085Z", + "updated_at": "2016-08-11T11:32:35.169Z", + "user": { + "name": "Administrator", + "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon" + } + } + ], "versions": [ { "id":2, -- cgit v1.2.3