summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/epics.md2
-rw-r--r--doc/api/feature_flag_specs.md2
-rw-r--r--doc/api/feature_flags_legacy.md2
-rw-r--r--doc/api/graphql/reference/gitlab_schema.graphql25
-rw-r--r--doc/api/graphql/reference/gitlab_schema.json78
-rw-r--r--doc/api/group_labels.md6
-rw-r--r--doc/api/issues.md2
-rw-r--r--doc/api/labels.md9
-rw-r--r--doc/api/merge_requests.md2
-rw-r--r--doc/api/namespaces.md3
-rw-r--r--doc/api/packages.md4
-rw-r--r--doc/api/projects.md9
-rw-r--r--doc/api/users.md6
13 files changed, 132 insertions, 18 deletions
diff --git a/doc/api/epics.md b/doc/api/epics.md
index f2c3796f20c..fcdbb8cea71 100644
--- a/doc/api/epics.md
+++ b/doc/api/epics.md
@@ -38,7 +38,7 @@ are paginated.
Read more on [pagination](README.md#pagination).
-CAUTION: **Deprecation**
+CAUTION: **Deprecation:**
> `reference` attribute in response is deprecated in favour of `references`.
> Introduced [GitLab 12.6](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/20354)
diff --git a/doc/api/feature_flag_specs.md b/doc/api/feature_flag_specs.md
index ef0d1b1ec14..eaa6ea36c23 100644
--- a/doc/api/feature_flag_specs.md
+++ b/doc/api/feature_flag_specs.md
@@ -8,7 +8,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/9566) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.5.
-CAUTION: **Deprecation**
+CAUTION: **Deprecation:**
This API is deprecated and [scheduled for removal in GitLab 14.0](https://gitlab.com/gitlab-org/gitlab/-/issues/213369).
The API for creating, updating, reading and deleting Feature Flag Specs.
diff --git a/doc/api/feature_flags_legacy.md b/doc/api/feature_flags_legacy.md
index 648f63f6f07..7e4fc47a1de 100644
--- a/doc/api/feature_flags_legacy.md
+++ b/doc/api/feature_flags_legacy.md
@@ -8,7 +8,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/9566) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.5.
-CAUTION: **Deprecation**
+CAUTION: **Deprecation:**
This API is deprecated and [scheduled for removal in GitLab 14.0](https://gitlab.com/gitlab-org/gitlab/-/issues/213369). Use [this API](feature_flags.md) instead.
API for accessing resources of [GitLab Feature Flags](../operations/feature_flags.md).
diff --git a/doc/api/graphql/reference/gitlab_schema.graphql b/doc/api/graphql/reference/gitlab_schema.graphql
index 5c894ebbef8..d0d68a403eb 100644
--- a/doc/api/graphql/reference/gitlab_schema.graphql
+++ b/doc/api/graphql/reference/gitlab_schema.graphql
@@ -4371,6 +4371,11 @@ The connection type for EpicIssue.
"""
type EpicIssueConnection {
"""
+ Total count of collection
+ """
+ count: Int!
+
+ """
A list of edges.
"""
edges: [EpicIssueEdge]
@@ -5044,6 +5049,11 @@ type Group {
iids: [String!]
"""
+ Iterations applied to the issue
+ """
+ iterationId: [ID]
+
+ """
Labels applied to this issue
"""
labelName: [String]
@@ -5968,6 +5978,11 @@ The connection type for Issue.
"""
type IssueConnection {
"""
+ Total count of collection
+ """
+ count: Int!
+
+ """
A list of edges.
"""
edges: [IssueEdge]
@@ -9200,6 +9215,11 @@ type Project {
iids: [String!]
"""
+ Iterations applied to the issue
+ """
+ iterationId: [ID]
+
+ """
Labels applied to this issue
"""
labelName: [String]
@@ -9295,6 +9315,11 @@ type Project {
iids: [String!]
"""
+ Iterations applied to the issue
+ """
+ iterationId: [ID]
+
+ """
Labels applied to this issue
"""
labelName: [String]
diff --git a/doc/api/graphql/reference/gitlab_schema.json b/doc/api/graphql/reference/gitlab_schema.json
index 088ab8bf418..02394f89ed1 100644
--- a/doc/api/graphql/reference/gitlab_schema.json
+++ b/doc/api/graphql/reference/gitlab_schema.json
@@ -12217,6 +12217,24 @@
"description": "The connection type for EpicIssue.",
"fields": [
{
+ "name": "count",
+ "description": "Total count of collection",
+ "args": [
+
+ ],
+ "type": {
+ "kind": "NON_NULL",
+ "name": null,
+ "ofType": {
+ "kind": "SCALAR",
+ "name": "Int",
+ "ofType": null
+ }
+ },
+ "isDeprecated": false,
+ "deprecationReason": null
+ },
+ {
"name": "edges",
"description": "A list of edges.",
"args": [
@@ -14042,6 +14060,20 @@
"defaultValue": "created_desc"
},
{
+ "name": "iterationId",
+ "description": "Iterations applied to the issue",
+ "type": {
+ "kind": "LIST",
+ "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": {
@@ -16429,6 +16461,24 @@
"description": "The connection type for Issue.",
"fields": [
{
+ "name": "count",
+ "description": "Total count of collection",
+ "args": [
+
+ ],
+ "type": {
+ "kind": "NON_NULL",
+ "name": null,
+ "ofType": {
+ "kind": "SCALAR",
+ "name": "Int",
+ "ofType": null
+ }
+ },
+ "isDeprecated": false,
+ "deprecationReason": null
+ },
+ {
"name": "edges",
"description": "A list of edges.",
"args": [
@@ -27439,6 +27489,20 @@
"ofType": null
},
"defaultValue": "created_desc"
+ },
+ {
+ "name": "iterationId",
+ "description": "Iterations applied to the issue",
+ "type": {
+ "kind": "LIST",
+ "name": null,
+ "ofType": {
+ "kind": "SCALAR",
+ "name": "ID",
+ "ofType": null
+ }
+ },
+ "defaultValue": null
}
],
"type": {
@@ -27620,6 +27684,20 @@
"defaultValue": "created_desc"
},
{
+ "name": "iterationId",
+ "description": "Iterations applied to the issue",
+ "type": {
+ "kind": "LIST",
+ "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": {
diff --git a/doc/api/group_labels.md b/doc/api/group_labels.md
index 5ae5ea4286a..260ee669e08 100644
--- a/doc/api/group_labels.md
+++ b/doc/api/group_labels.md
@@ -170,7 +170,8 @@ Example response:
}
```
-NOTE: **Note:** An older endpoint `PUT /groups/:id/labels` with `name` in the parameters is still available, but deprecated.
+NOTE: **Note:**
+An older endpoint `PUT /groups/:id/labels` with `name` in the parameters is still available, but deprecated.
## Delete a group label
@@ -189,7 +190,8 @@ DELETE /groups/:id/labels/:label_id
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/labels/bug"
```
-NOTE: **Note:** An older endpoint `DELETE /groups/:id/labels` with `name` in the parameters is still available, but deprecated.
+NOTE: **Note:**
+An older endpoint `DELETE /groups/:id/labels` with `name` in the parameters is still available, but deprecated.
## Subscribe to a group label
diff --git a/doc/api/issues.md b/doc/api/issues.md
index a4555b2a712..22f5d994f85 100644
--- a/doc/api/issues.md
+++ b/doc/api/issues.md
@@ -16,7 +16,7 @@ are paginated.
Read more on [pagination](README.md#pagination).
-CAUTION: **Deprecation**
+CAUTION: **Deprecation:**
> `reference` attribute in response is deprecated in favour of `references`.
> Introduced [GitLab 12.6](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/20354)
diff --git a/doc/api/labels.md b/doc/api/labels.md
index 3ab059fca7c..30290f18653 100644
--- a/doc/api/labels.md
+++ b/doc/api/labels.md
@@ -199,7 +199,8 @@ DELETE /projects/:id/labels/:label_id
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/labels/bug"
```
-NOTE: **Note:** An older endpoint `DELETE /projects/:id/labels` with `name` in the parameters is still available, but deprecated.
+NOTE: **Note:**
+An older endpoint `DELETE /projects/:id/labels` with `name` in the parameters is still available, but deprecated.
## Edit an existing label
@@ -242,7 +243,8 @@ Example response:
}
```
-NOTE: **Note:** An older endpoint `PUT /projects/:id/labels` with `name` or `label_id` in the parameters is still available, but deprecated.
+NOTE: **Note:**
+An older endpoint `PUT /projects/:id/labels` with `name` or `label_id` in the parameters is still available, but deprecated.
## Promote a project label to a group label
@@ -279,7 +281,8 @@ Example response:
}
```
-NOTE: **Note:** An older endpoint `PUT /projects/:id/labels/promote` with `name` in the parameters is still available, but deprecated.
+NOTE: **Note:**
+An older endpoint `PUT /projects/:id/labels/promote` with `name` in the parameters is still available, but deprecated.
## Subscribe to a label
diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md
index 2ec399fc507..070d21d99aa 100644
--- a/doc/api/merge_requests.md
+++ b/doc/api/merge_requests.md
@@ -2,7 +2,7 @@
Every API call to merge requests must be authenticated.
-CAUTION: **Deprecation**
+CAUTION: **Deprecation:**
> `reference` attribute in response is deprecated in favour of `references`.
> Introduced [GitLab 12.6](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/20354)
diff --git a/doc/api/namespaces.md b/doc/api/namespaces.md
index d1a2812bfb4..e38e725fb97 100644
--- a/doc/api/namespaces.md
+++ b/doc/api/namespaces.md
@@ -68,7 +68,8 @@ the `plan` parameter associated with a namespace:
]
```
-NOTE: **Note:** Only group maintainers/owners are presented with `members_count_with_descendants`, as well as `plan` **(BRONZE ONLY)**.
+NOTE: **Note:**
+Only group maintainers/owners are presented with `members_count_with_descendants`, as well as `plan` **(BRONZE ONLY)**.
## Search for namespace
diff --git a/doc/api/packages.md b/doc/api/packages.md
index ca7113bc743..19828208a26 100644
--- a/doc/api/packages.md
+++ b/doc/api/packages.md
@@ -80,7 +80,7 @@ GET /groups/:id/packages
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/packages?exclude_subgroups=true"
```
-CAUTION: **Deprecation**
+CAUTION: **Deprecation:**
> The `build_info` attribute in the response is deprecated in favour of `pipeline`.
> Introduced [GitLab 12.10](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28040).
@@ -165,7 +165,7 @@ GET /projects/:id/packages/:package_id
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/packages/:package_id"
```
-CAUTION: **Deprecation**
+CAUTION: **Deprecation:**
> The `build_info` attribute in the response is deprecated in favour of `pipeline`.
> Introduced [GitLab 12.10](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28040).
diff --git a/doc/api/projects.md b/doc/api/projects.md
index ea8f154b144..6464b1db06e 100644
--- a/doc/api/projects.md
+++ b/doc/api/projects.md
@@ -1087,7 +1087,8 @@ POST /projects
| `group_with_project_templates_id` | integer | no | **(PREMIUM)** For group-level custom templates, specifies ID of group from which all the custom project templates are sourced. Leave empty for instance-level templates. Requires `use_custom_template` to be true |
| `packages_enabled` | boolean | no | **(PREMIUM ONLY)** Enable or disable packages repository feature |
-NOTE: **Note:** If your HTTP repository is not publicly accessible,
+NOTE: **Note:**
+If your HTTP repository is not publicly accessible,
add authentication information to the URL: `https://username:password@gitlab.company.com/group/project.git`
where `password` is a public access key with the `api` scope enabled.
@@ -1157,7 +1158,8 @@ POST /projects/user/:user_id
| `group_with_project_templates_id` | integer | no | **(PREMIUM)** For group-level custom templates, specifies ID of group from which all the custom project templates are sourced. Leave empty for instance-level templates. Requires `use_custom_template` to be true |
| `packages_enabled` | boolean | no | **(PREMIUM ONLY)** Enable or disable packages repository feature |
-NOTE: **Note:** If your HTTP repository is not publicly accessible,
+NOTE: **Note:**
+If your HTTP repository is not publicly accessible,
add authentication information to the URL: `https://username:password@gitlab.company.com/group/project.git`
where `password` is a public access key with the `api` scope enabled.
@@ -1228,7 +1230,8 @@ PUT /projects/:id
| `packages_enabled` | boolean | no | **(PREMIUM ONLY)** Enable or disable packages repository feature |
| `service_desk_enabled` | boolean | no | **(PREMIUM ONLY)** Enable or disable service desk feature |
-NOTE: **Note:** If your HTTP repository is not publicly accessible,
+NOTE: **Note:**
+If your HTTP repository is not publicly accessible,
add authentication information to the URL: `https://username:password@gitlab.company.com/group/project.git`
where `password` is a public access key with the `api` scope enabled.
diff --git a/doc/api/users.md b/doc/api/users.md
index a6ae4f384aa..505468945cb 100644
--- a/doc/api/users.md
+++ b/doc/api/users.md
@@ -318,7 +318,8 @@ Example Responses:
}
```
-NOTE: **Note:** The `plan` and `trial` parameters are only available on GitLab Enterprise Edition.
+NOTE: **Note:**
+The `plan` and `trial` parameters are only available on GitLab Enterprise Edition.
Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) will also see
the `shared_runners_minutes_limit`, and `extra_shared_runners_minutes_limit` parameters.
@@ -1412,7 +1413,8 @@ Parameters:
### Get user activities (admin only)
-NOTE: **Note:** This API endpoint is only available on 8.15 (EE) and 9.1 (CE) and above.
+NOTE: **Note:**
+This API endpoint is only available on 8.15 (EE) and 9.1 (CE) and above.
Get the last activity date for all users, sorted from oldest to newest.
View Lorry Controller Status