summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarcel Amirault <mamirault@gitlab.com>2019-07-03 16:33:58 +0900
committerMarcel Amirault <mamirault@gitlab.com>2019-07-03 16:33:58 +0900
commit42e268977045c04bdeab1b4719fdc4993e9a3716 (patch)
tree7788667a37ee522424fdd9a7aca3dfa506607f9d
parentc68cf9e5e9fd2a6767e7913668ad88a29a0cfbff (diff)
downloadgitlab-ce-docs-api-merge-new-2.tar.gz
Expand json examples for EE api docsdocs-api-merge-new-2
Make json examples easier to follow by including the brackets and a few sample parameters
-rw-r--r--doc/api/group_boards.md4
-rw-r--r--doc/api/issues.md53
-rw-r--r--doc/api/merge_requests.md58
-rw-r--r--doc/api/namespaces.md9
-rw-r--r--doc/api/notification_settings.md10
-rw-r--r--doc/api/projects.md12
-rw-r--r--doc/api/protected_branches.md6
-rw-r--r--doc/api/settings.md4
-rw-r--r--doc/api/users.md5
9 files changed, 144 insertions, 17 deletions
diff --git a/doc/api/group_boards.md b/doc/api/group_boards.md
index f4d71dd03cd..4bee05a128a 100644
--- a/doc/api/group_boards.md
+++ b/doc/api/group_boards.md
@@ -65,7 +65,7 @@ Users on GitLab [Premium, Silver, or higher](https://about.gitlab.com/pricing/)
different parameters, due to the ability to have multiple group boards. Refer to the table
above to see what enpoint(s) belong to each tier.
-Example response: **[PREMIUM]**
+Example response:
```json
[
@@ -172,7 +172,7 @@ Example response:
Users on GitLab [Premium, Silver, or higher](https://about.gitlab.com/pricing/) will see
different parameters, due to the ability to have multiple group boards:
-Example response: **[PREMIUM]**
+Example response:
```json
{
diff --git a/doc/api/issues.md b/doc/api/issues.md
index 812a58a99b0..b29626525da 100644
--- a/doc/api/issues.md
+++ b/doc/api/issues.md
@@ -149,7 +149,14 @@ Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/)
the `weight` parameter:
```json
+[
+ {
+ "state" : "opened",
+ "description" : "Ratione dolores corrupti mollitia soluta quia.",
"weight": null,
+ ...
+ }
+]
```
**Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API.
@@ -291,7 +298,14 @@ Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/)
the `weight` parameter:
```json
+[
+ {
+ "project_id" : 4,
+ "description" : "Omnis vero earum sunt corporis dolor et placeat.",
"weight": null,
+ ...
+ }
+]
```
**Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API.
@@ -441,7 +455,14 @@ Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/)
the `weight` parameter:
```json
+[
+ {
+ "project_id" : 4,
+ "description" : "Omnis vero earum sunt corporis dolor et placeat.",
"weight": null,
+ ...
+ }
+]
```
**Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API.
@@ -548,7 +569,12 @@ Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/)
the `weight` parameter:
```json
+{
+ "project_id" : 4,
+ "description" : "Omnis vero earum sunt corporis dolor et placeat.",
"weight": null,
+ ...
+}
```
**Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API.
@@ -643,7 +669,12 @@ Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/)
the `weight` parameter:
```json
+{
+ "project_id" : 4,
+ "description" : null,
"weight": null,
+ ...
+}
```
**Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API.
@@ -746,7 +777,12 @@ Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/)
the `weight` parameter:
```json
+{
+ "project_id" : 4,
+ "description" : null,
"weight": null,
+ ...
+}
```
**Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API.
@@ -863,7 +899,12 @@ Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/)
the `weight` parameter:
```json
+{
+ "project_id": 5,
+ "description": "Repellat voluptas quibusdam voluptatem exercitationem.",
"weight": null,
+ ...
+}
```
**Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API.
@@ -959,7 +1000,12 @@ Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/)
the `weight` parameter:
```json
+{
+ "project_id": 5,
+ "description": "Repellat voluptas quibusdam voluptatem exercitationem.",
"weight": null,
+ ...
+}
```
**Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API.
@@ -1139,13 +1185,6 @@ Example response:
}
```
-Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) will also see
-the `weight` parameter:
-
-```json
- "weight": null,
-```
-
**Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API.
**Note**: The `closed_by` attribute was [introduced in GitLab 10.6][ce-17042]. This value will only be present for issues which were closed after GitLab 10.6 and when the user account that closed the issue still exists.
diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md
index c2c4ddd8726..69db9f97a35 100644
--- a/doc/api/merge_requests.md
+++ b/doc/api/merge_requests.md
@@ -152,7 +152,14 @@ Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/)
the `approvals_before_merge` parameter:
```json
+[
+ {
+ "id": 1,
+ "title": "test1",
"approvals_before_merge": null
+ ...
+ }
+]
```
## List project merge requests
@@ -306,7 +313,14 @@ Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/)
the `approvals_before_merge` parameter:
```json
+[
+ {
+ "id": 1,
+ "title": "test1",
"approvals_before_merge": null
+ ...
+ }
+]
```
## List group merge requests
@@ -448,7 +462,14 @@ Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/)
the `approvals_before_merge` parameter:
```json
+[
+ {
+ "id": 1,
+ "title": "test1",
"approvals_before_merge": null
+ ...
+ }
+]
```
## Get single MR
@@ -593,7 +614,12 @@ Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/)
the `approvals_before_merge` parameter:
```json
- "approvals_before_merge": null
+{
+ "id": 1,
+ "title": "test1",
+ "approvals_before_merge": null
+ ...
+}
```
## Get single MR participants
@@ -938,7 +964,12 @@ Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/)
the `approvals_before_merge` parameter:
```json
+{
+ "id": 1,
+ "title": "test1",
"approvals_before_merge": null
+ ...
+}
```
## Update MR
@@ -1086,7 +1117,12 @@ Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/)
the `approvals_before_merge` parameter:
```json
+{
+ "id": 1,
+ "title": "test1",
"approvals_before_merge": null
+ ...
+}
```
## Delete a merge request
@@ -1250,7 +1286,12 @@ Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/)
the `approvals_before_merge` parameter:
```json
+{
+ "id": 1,
+ "title": "test1",
"approvals_before_merge": null
+ ...
+}
```
## Merge to default merge ref path
@@ -1415,7 +1456,12 @@ Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/)
the `approvals_before_merge` parameter:
```json
+{
+ "id": 1,
+ "title": "test1",
"approvals_before_merge": null
+ ...
+}
```
## Rebase a merge request
@@ -1689,7 +1735,12 @@ Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/)
the `approvals_before_merge` parameter:
```json
+{
+ "id": 1,
+ "title": "test1",
"approvals_before_merge": null
+ ...
+}
```
## Unsubscribe from a merge request
@@ -1829,7 +1880,12 @@ Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/)
the `approvals_before_merge` parameter:
```json
+{
+ "id": 1,
+ "title": "test1",
"approvals_before_merge": null
+ ...
+}
```
## Create a todo
diff --git a/doc/api/namespaces.md b/doc/api/namespaces.md
index b90f66b7f71..b354e2b9ab2 100644
--- a/doc/api/namespaces.md
+++ b/doc/api/namespaces.md
@@ -58,7 +58,14 @@ Users on GitLab.com [Bronze or higher](https://about.gitlab.com/pricing/#gitlab-
the `plan` parameter associated with a namespace:
```json
- "plan": "bronze"
+[
+ {
+ "id": 1,
+ "name": "user1",
+ "plan": "bronze",
+ ...
+ }
+]
```
**Note**: Only group maintainers/owners are presented with `members_count_with_descendants`, as well as `plan` **[BRONZE ONLY]**.
diff --git a/doc/api/notification_settings.md b/doc/api/notification_settings.md
index 7716e21d0ea..0342622f384 100644
--- a/doc/api/notification_settings.md
+++ b/doc/api/notification_settings.md
@@ -188,5 +188,13 @@ Users on GitLab [Ultimate or Gold](https://about.gitlab.com/pricing/) will also
the `new_epic` parameter:
```json
- "new_epic": false
+{
+ "level": "custom",
+ "events": {
+ "new_note": true,
+ "new_issue": false,
+ "new_epic": false,
+ ...
+ }
+}
```
diff --git a/doc/api/projects.md b/doc/api/projects.md
index 7c3a30e62eb..b8ccf25581e 100644
--- a/doc/api/projects.md
+++ b/doc/api/projects.md
@@ -260,7 +260,14 @@ Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/)
the `approvals_before_merge` parameter:
```json
+[
+ {
+ "id": 4,
+ "description": null,
"approvals_before_merge": 0,
+ ...
+ }
+]
```
You can filter by [custom attributes](custom_attributes.md) with:
@@ -590,7 +597,12 @@ Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/)
the `approvals_before_merge` parameter:
```json
+{
+ "id": 3,
+ "description": null,
"approvals_before_merge": 0,
+ ...
+}
```
**Note**: The `web_url` and `avatar_url` attributes on `namespace` were [introduced][ce-27427] in GitLab 11.11.
diff --git a/doc/api/protected_branches.md b/doc/api/protected_branches.md
index 36242cb4d12..6e41584afef 100644
--- a/doc/api/protected_branches.md
+++ b/doc/api/protected_branches.md
@@ -55,7 +55,7 @@ Example response:
Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) will also see
the `user_id` and `group_id` parameters:
-Example response: **[STARTER]**
+Example response:
```json
[
@@ -122,7 +122,7 @@ Example response:
Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) will also see
the `user_id` and `group_id` parameters:
-Example response: **[STARTER]**
+Example response:
```json
{
@@ -198,7 +198,7 @@ Example response:
Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) will also see
the `user_id` and `group_id` parameters:
-Example response: **[STARTER]**
+Example response:
```json
{
diff --git a/doc/api/settings.md b/doc/api/settings.md
index e84787722dc..876a5a75590 100644
--- a/doc/api/settings.md
+++ b/doc/api/settings.md
@@ -195,10 +195,10 @@ are listed in the descriptions of the relevant settings.
| `elasticsearch_aws_access_key` | string | no | **[Premium]** AWS IAM access key |
| `elasticsearch_aws_region` | string | no | **[Premium]** The AWS region the elasticsearch domain is configured |
| `elasticsearch_aws_secret_access_key` | string | no | **[Premium]** AWS IAM secret access key |
-| `elasticsearch_experimental_indexer` | boolean | no | **[Premium]** Use the experimental elasticsearch indexer. More info: https://gitlab.com/gitlab-org/gitlab-elasticsearch-indexer |
+| `elasticsearch_experimental_indexer` | boolean | no | **[Premium]** Use the experimental elasticsearch indexer. More info: <https://gitlab.com/gitlab-org/gitlab-elasticsearch-indexer> |
| `elasticsearch_indexing` | boolean | no | **[Premium]** Enable Elasticsearch indexing |
| `elasticsearch_search` | boolean | no | **[Premium]** Enable Elasticsearch search |
-| `elasticsearch_url` | string | no | **[Premium]** The url to use for connecting to Elasticsearch. Use a comma-separated list to support cluster (e.g., "http://localhost:9200, http://localhost:9201"). If your Elasticsearch instance is password protected, pass the `username:password` in the URL (e.g., `http://<username>:<password>@<elastic_host>:9200/`). |
+| `elasticsearch_url` | string | no | **[Premium]** The url to use for connecting to Elasticsearch. Use a comma-separated list to support cluster (e.g., `http://localhost:9200, http://localhost:9201"`). If your Elasticsearch instance is password protected, pass the `username:password` in the URL (e.g., `http://<username>:<password>@<elastic_host>:9200/`). |
| `elasticsearch_limit_indexing` | boolean | no | **[Premium]** Limit Elasticsearch to index certain namespaces and projects |
| `elasticsearch_project_ids` | array of integers | no | **[Premium]** The projects to index via Elasticsearch if `elasticsearch_limit_indexing` is enabled. |
| `elasticsearch_namespace_ids` | array of integers | no | **[Premium]** The namespaces to index via Elasticsearch if `elasticsearch_limit_indexing` is enabled. |
diff --git a/doc/api/users.md b/doc/api/users.md
index aaf1a27220d..5615dcdd307 100644
--- a/doc/api/users.md
+++ b/doc/api/users.md
@@ -270,8 +270,13 @@ Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/)
the `shared_runners_minutes_limit` and `extra_shared_runners_minutes_limit` parameters: **[STARTER]**
```json
+{
+ "id": 1,
+ "username": "john_smith",
"shared_runners_minutes_limit": 133,
"extra_shared_runners_minutes_limit": 133
+ ...
+}
```
You can include the user's [custom attributes](custom_attributes.md) in the response with: