Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2023-05-10 18:13:04 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2023-05-10 18:13:04 +0300
commit4e9ceea7f8ff3e097ad45f6f54c1b7165248e848 (patch)
tree6cc413c085934f15c789d539f69dcb89600c71fb /doc/api
parent0e0df204c1a0d859ccbbe1be83a5e09a53381f17 (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/graphql/reference/index.md1
-rw-r--r--doc/api/lint.md2
-rw-r--r--doc/api/project_snippets.md108
3 files changed, 55 insertions, 56 deletions
diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md
index 412556b6657..b4d43886c97 100644
--- a/doc/api/graphql/reference/index.md
+++ b/doc/api/graphql/reference/index.md
@@ -18938,6 +18938,7 @@ Represents a product analytics dashboard visualization.
| <a id="projectpathlocks"></a>`pathLocks` | [`PathLockConnection`](#pathlockconnection) | The project's path locks. (see [Connections](#connections)) |
| <a id="projectpipelineanalytics"></a>`pipelineAnalytics` | [`PipelineAnalytics`](#pipelineanalytics) | Pipeline analytics. |
| <a id="projectprintingmergerequestlinkenabled"></a>`printingMergeRequestLinkEnabled` | [`Boolean`](#boolean) | Indicates if a link to create or view a merge request should display after a push to Git repositories of the project from the command line. |
+| <a id="projectproductanalyticsinstrumentationkey"></a>`productAnalyticsInstrumentationKey` **{warning-solid}** | [`String`](#string) | **Introduced** in 16.0. This feature is an Experiment. It can be changed or removed at any time. Product Analytics instrumentation key assigned to the project. |
| <a id="projectproductanalyticsstate"></a>`productAnalyticsState` **{warning-solid}** | [`ProductAnalyticsState`](#productanalyticsstate) | **Introduced** in 15.10. This feature is an Experiment. It can be changed or removed at any time. Current state of the product analytics stack for this project.Can only be called for one project in a single request. |
| <a id="projectpublicjobs"></a>`publicJobs` | [`Boolean`](#boolean) | Indicates if there is public access to pipelines and job details of the project, including output logs and artifacts. |
| <a id="projectpushrules"></a>`pushRules` | [`PushRules`](#pushrules) | Project's push rules settings. |
diff --git a/doc/api/lint.md b/doc/api/lint.md
index 9de9aa23560..cfd34f6a40c 100644
--- a/doc/api/lint.md
+++ b/doc/api/lint.md
@@ -112,7 +112,7 @@ Example responses:
WARNING:
This endpoint was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/381669) in GitLab 15.7
-and is planned for removal in 16.0. Use [`POST /projects/:id/ci/lint`](#validate-a-ci-yaml-configuration-with-a-namespace) instead.
+and was [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/403256) in 16.0. Use [`POST /projects/:id/ci/lint`](#validate-a-ci-yaml-configuration-with-a-namespace) instead.
Checks if CI/CD YAML configuration is valid. This endpoint validates basic CI/CD
configuration syntax. It doesn't have any namespace-specific context.
diff --git a/doc/api/project_snippets.md b/doc/api/project_snippets.md
index 242edf7d768..e39836f2781 100644
--- a/doc/api/project_snippets.md
+++ b/doc/api/project_snippets.md
@@ -13,11 +13,9 @@ You can set it with the `visibility` field in the snippet.
Constants for snippet visibility levels are:
-| visibility | Description |
-| ---------- | ----------- |
-| `private` | The snippet is visible only to project members. |
-| `internal` | The snippet is visible for any authenticated user except [external users](../user/admin_area/external_users.md). |
-| `public` | The snippet can be accessed without any authentication. |
+- **Private**: The snippet is visible only to project members.
+- **Internal**: The snippet is visible for any authenticated user except [external users](../user/admin_area/external_users.md).
+- **Public**: The snippet can be accessed without any authentication.
NOTE:
From July 2019, the `Internal` visibility setting is disabled for new projects, groups,
@@ -35,9 +33,9 @@ GET /projects/:id/snippets
Parameters:
-| Attribute | Type | Required | Description |
-|-----------|----------------|----------|-----------------------------------------------------------------------------------------------------------------|
-| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) owned by the authenticated user. |
+| Attribute | Type | Required | Description |
+|-----------|----------------|----------|-------------|
+| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) owned by the authenticated user.
## Single snippet
@@ -49,10 +47,10 @@ GET /projects/:id/snippets/:snippet_id
Parameters:
-| Attribute | Type | Required | Description |
-|--------------|----------------|----------|-----------------------------------------------------------------------------------------------------------------|
-| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) owned by the authenticated user. |
-| `snippet_id` | integer | yes | The ID of a project's snippet. |
+| Attribute | Type | Required | Description |
+|--------------|----------------|----------|-------------|
+| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) owned by the authenticated user.
+| `snippet_id` | integer | yes | The ID of a project's snippet.
```json
{
@@ -86,17 +84,17 @@ POST /projects/:id/snippets
Parameters:
-| Attribute | Type | Required | Description |
-|:------------------|:----------------|:---------|:----------------------------------------------------------------------------------------------------------------|
-| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) owned by the authenticated user. |
-| `title` | string | yes | Title of a snippet. |
-| `file_name` | string | no | Deprecated: Use `files` instead. Name of a snippet file. |
-| `content` | string | no | Deprecated: Use `files` instead. Content of a snippet. |
-| `description` | string | no | Description of a snippet. |
-| `visibility` | string | no | Snippet's [visibility](#snippet-visibility-level) |
-| `files` | array of hashes | no | An array of snippet files. |
-| `files:file_path` | string | yes | File path of the snippet file. |
-| `files:content` | string | yes | Content of the snippet file. |
+| Attribute | Type | Required | Description |
+|:------------------|:----------------|:---------|:------------|
+| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) owned by the authenticated user.
+| `files:content` | string | yes | Content of the snippet file.
+| `files:file_path` | string | yes | File path of the snippet file.
+| `title` | string | yes | Title of a snippet.
+| `content` | string | no | Deprecated: Use `files` instead. Content of a snippet.
+| `description` | string | no | Description of a snippet.
+| `file_name` | string | no | Deprecated: Use `files` instead. Name of a snippet file.
+| `files` | array of hashes | no | An array of snippet files.
+| `visibility` | string | no | Snippet's [visibility](#snippet-visibility-level).
Example request:
@@ -127,7 +125,7 @@ curl --request POST "https://gitlab.com/api/v4/projects/:id/snippets" \
Updates an existing project snippet. The user must have permission to change an existing snippet.
-Updates to snippets with multiple files *must* use the `files` attribute.
+Updates to snippets with multiple files must use the `files` attribute.
```plaintext
PUT /projects/:id/snippets/:snippet_id
@@ -135,20 +133,20 @@ PUT /projects/:id/snippets/:snippet_id
Parameters:
-| Attribute | Type | Required | Description |
-|:----------------------|:----------------|:---------|:----------------------------------------------------------------------------------------------------------------|
-| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) owned by the authenticated user. |
-| `snippet_id` | integer | yes | The ID of a project's snippet. |
-| `title` | string | no | Title of a snippet. |
-| `file_name` | string | no | Deprecated: Use `files` instead. Name of a snippet file. |
-| `content` | string | no | Deprecated: Use `files` instead. Content of a snippet. |
-| `description` | string | no | Description of a snippet. |
-| `visibility` | string | no | Snippet's [visibility](#snippet-visibility-level) |
-| `files` | array of hashes | no | An array of snippet files. |
-| `files:action` | string | yes | Type of action to perform on the file, one of: `create`, `update`, `delete`, `move` |
-| `files:file_path` | string | no | File path of the snippet file. |
-| `files:previous_path` | string | no | Previous path of the snippet file. |
-| `files:content` | string | no | Content of the snippet file. |
+| Attribute | Type | Required | Description |
+|:----------------------|:----------------|:---------|:------------|
+| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) owned by the authenticated user.
+| `files:action` | string | yes | Type of action to perform on the file. One of: `create`, `update`, `delete`, `move`.
+| `snippet_id` | integer | yes | The ID of a project's snippet.
+| `content` | string | no | Deprecated: Use `files` instead. Content of a snippet.
+| `description` | string | no | Description of a snippet.
+| `files` | array of hashes | no | An array of snippet files.
+| `files:content` | string | no | Content of the snippet file.
+| `files:file_path` | string | no | File path of the snippet file.
+| `file_name` | string | no | Deprecated: Use `files` instead. Name of a snippet file.
+| `files:previous_path` | string | no | Previous path of the snippet file.
+| `title` | string | no | Title of a snippet.
+| `visibility` | string | no | Snippet's [visibility](#snippet-visibility-level).
Example request:
@@ -186,10 +184,10 @@ DELETE /projects/:id/snippets/:snippet_id
Parameters:
-| Attribute | Type | Required | Description |
-|:-------------|:---------------|:---------|:----------------------------------------------------------------------------------------------------------------|
-| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) owned by the authenticated user. |
-| `snippet_id` | integer | yes | The ID of a project's snippet. |
+| Attribute | Type | Required | Description |
+|:-------------|:---------------|:---------|:------------|
+| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) owned by the authenticated user.
+| `snippet_id` | integer | yes | The ID of a project's snippet.
Example request:
@@ -208,10 +206,10 @@ GET /projects/:id/snippets/:snippet_id/raw
Parameters:
-| Attribute | Type | Required | Description |
+| Attribute | Type | Required | Description |
|:-------------|:---------------|:---------|:----------------------------------------------------------------------------------------------------------------|
-| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) owned by the authenticated user. |
-| `snippet_id` | integer | yes | The ID of a project's snippet. |
+| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) owned by the authenticated user.
+| `snippet_id` | integer | yes | The ID of a project's snippet.
Example request:
@@ -230,12 +228,12 @@ GET /projects/:id/snippets/:snippet_id/files/:ref/:file_path/raw
Parameters:
-| Attribute | Type | Required | Description |
-|:-------------|:---------------|:---------|:----------------------------------------------------------------------------------------------------------------|
-| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) owned by the authenticated user |
-| `snippet_id` | integer | yes | The ID of a project's snippet. |
-| `ref` | string | yes | The name of a branch, tag or commit, for example, main. |
-| `file_path` | string | yes | The URL-encoded path to the file, for example, snippet%2Erb. |
+| Attribute | Type | Required | Description |
+|:-------------|:---------------|:---------|:------------|
+| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) owned by the authenticated user.
+| `file_path` | string | yes | The URL-encoded path to the file, for example, `snippet%2Erb`.
+| `ref` | string | yes | The name of a branch, tag or commit, for example, `main`.
+| `snippet_id` | integer | yes | The ID of a project's snippet.
Example request:
@@ -252,10 +250,10 @@ Available only for users with administrator access.
GET /projects/:id/snippets/:snippet_id/user_agent_detail
```
-| Attribute | Type | Required | Description |
-|--------------|----------------|----------|-----------------------------------------------------------------------------------------------------------------|
-| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) owned by the authenticated user. |
-| `snippet_id` | Integer | yes | The ID of a snippet. |
+| Attribute | Type | Required | Description |
+|--------------|----------------|----------|-------------|
+| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) owned by the authenticated user.
+| `snippet_id` | Integer | yes | The ID of a snippet.
Example request: