Commit 8c8b0085 authored by Parker Mauney's avatar Parker Mauney Committed by Achilleas Pipinellis

Fix malformed JSON objects in API docs

Add missing object delimiters.
Split notification_settings multi-example into separate blocks.
parent 4a6d3081
...@@ -591,55 +591,57 @@ Example response: ...@@ -591,55 +591,57 @@ Example response:
```json ```json
{ {
"id" : 1, "id": 1,
"milestone" : { "milestone": {
"due_date" : null, "due_date": null,
"project_id" : 4, "project_id": 4,
"state" : "closed", "state": "closed",
"description" : "Rerum est voluptatem provident consequuntur molestias similique ipsum dolor.", "description": "Rerum est voluptatem provident consequuntur molestias similique ipsum dolor.",
"iid" : 3, "iid": 3,
"id" : 11, "id": 11,
"title" : "v3.0", "title": "v3.0",
"created_at" : "2016-01-04T15:31:39.788Z", "created_at": "2016-01-04T15:31:39.788Z",
"updated_at" : "2016-01-04T15:31:39.788Z", "updated_at": "2016-01-04T15:31:39.788Z",
"closed_at" : "2016-01-05T15:31:46.176Z" "closed_at": "2016-01-05T15:31:46.176Z"
}, },
"author" : { "author": {
"state" : "active", "state": "active",
"web_url" : "https://gitlab.example.com/root", "web_url": "https://gitlab.example.com/root",
"avatar_url" : null, "avatar_url": null,
"username" : "root", "username": "root",
"id" : 1, "id": 1,
"name" : "Administrator" "name": "Administrator"
}, },
"description" : "Omnis vero earum sunt corporis dolor et placeat.", "description": "Omnis vero earum sunt corporis dolor et placeat.",
"state" : "closed", "state": "closed",
"iid" : 1, "iid": 1,
"assignees" : [{ "assignees": [
"avatar_url" : null, {
"web_url" : "https://gitlab.example.com/lennie", "avatar_url": null,
"state" : "active", "web_url": "https://gitlab.example.com/lennie",
"username" : "lennie", "state": "active",
"id" : 9, "username": "lennie",
"name" : "Dr. Luella Kovacek" "id": 9,
}], "name": "Dr. Luella Kovacek"
"assignee" : { }
"avatar_url" : null, ],
"web_url" : "https://gitlab.example.com/lennie", "assignee": {
"state" : "active", "avatar_url": null,
"username" : "lennie", "web_url": "https://gitlab.example.com/lennie",
"id" : 9, "state": "active",
"name" : "Dr. Luella Kovacek" "username": "lennie",
"id": 9,
"name": "Dr. Luella Kovacek"
}, },
"labels" : [], "labels": [],
"upvotes": 4, "upvotes": 4,
"downvotes": 0, "downvotes": 0,
"merge_requests_count": 0, "merge_requests_count": 0,
"title" : "Ut commodi ullam eos dolores perferendis nihil sunt.", "title": "Ut commodi ullam eos dolores perferendis nihil sunt.",
"updated_at" : "2016-01-04T15:31:46.176Z", "updated_at": "2016-01-04T15:31:46.176Z",
"created_at" : "2016-01-04T15:31:46.176Z", "created_at": "2016-01-04T15:31:46.176Z",
"closed_at" : null, "closed_at": null,
"closed_by" : null, "closed_by": null,
"subscribed": false, "subscribed": false,
"user_notes_count": 1, "user_notes_count": 1,
"due_date": null, "due_date": null,
...@@ -657,9 +659,9 @@ Example response: ...@@ -657,9 +659,9 @@ Example response:
}, },
"confidential": false, "confidential": false,
"discussion_locked": false, "discussion_locked": false,
"task_completion_status":{ "task_completion_status": {
"count":0, "count": 0,
"completed_count":0 "completed_count": 0
}, },
"weight": null, "weight": null,
"has_tasks": false, "has_tasks": false,
......
...@@ -176,7 +176,9 @@ Example responses: ...@@ -176,7 +176,9 @@ Example responses:
{ {
"level": "watch" "level": "watch"
} }
```
```json
{ {
"level": "custom", "level": "custom",
"events": { "events": {
......
...@@ -69,6 +69,7 @@ Example response: ...@@ -69,6 +69,7 @@ Example response:
"path_with_namespace": "namespace1/project1", "path_with_namespace": "namespace1/project1",
"created_at": "2020-05-07T04:27:17.016Z" "created_at": "2020-05-07T04:27:17.016Z"
} }
}
] ]
``` ```
...@@ -112,6 +113,7 @@ Example response: ...@@ -112,6 +113,7 @@ Example response:
"path_with_namespace": "namespace1/project1", "path_with_namespace": "namespace1/project1",
"created_at": "2020-05-07T04:27:17.016Z" "created_at": "2020-05-07T04:27:17.016Z"
} }
}
] ]
``` ```
...@@ -150,6 +152,7 @@ Example response: ...@@ -150,6 +152,7 @@ Example response:
"path": "project1", "path": "project1",
"path_with_namespace": "namespace1/project1", "path_with_namespace": "namespace1/project1",
"created_at": "2020-05-07T04:27:17.016Z" "created_at": "2020-05-07T04:27:17.016Z"
}
} }
``` ```
...@@ -189,6 +192,7 @@ Example response: ...@@ -189,6 +192,7 @@ Example response:
"path": "project1", "path": "project1",
"path_with_namespace": "namespace1/project1", "path_with_namespace": "namespace1/project1",
"created_at": "2020-05-07T04:27:17.016Z" "created_at": "2020-05-07T04:27:17.016Z"
}
} }
``` ```
...@@ -237,6 +241,7 @@ Example response: ...@@ -237,6 +241,7 @@ Example response:
"path": "project1", "path": "project1",
"path_with_namespace": "namespace1/project1", "path_with_namespace": "namespace1/project1",
"created_at": "2020-05-07T04:27:17.016Z" "created_at": "2020-05-07T04:27:17.016Z"
}
} }
``` ```
......
...@@ -1660,8 +1660,7 @@ Example responses: ...@@ -1660,8 +1660,7 @@ Example responses:
[ [
{ {
"starred_since": "2019-01-28T14:47:30.642Z", "starred_since": "2019-01-28T14:47:30.642Z",
"user": "user": {
{
"id": 1, "id": 1,
"username": "jane_smith", "username": "jane_smith",
"name": "Jane Smith", "name": "Jane Smith",
...@@ -1670,9 +1669,9 @@ Example responses: ...@@ -1670,9 +1669,9 @@ Example responses:
"web_url": "http://localhost:3000/jane_smith" "web_url": "http://localhost:3000/jane_smith"
} }
}, },
"starred_since": "2018-01-02T11:40:26.570Z",
"user":
{ {
"starred_since": "2018-01-02T11:40:26.570Z",
"user": {
"id": 2, "id": 2,
"username": "janine_smith", "username": "janine_smith",
"name": "Janine Smith", "name": "Janine Smith",
...@@ -1680,6 +1679,7 @@ Example responses: ...@@ -1680,6 +1679,7 @@ Example responses:
"avatar_url": "http://gravatar.com/../e32131cd8.jpeg", "avatar_url": "http://gravatar.com/../e32131cd8.jpeg",
"web_url": "http://localhost:3000/janine_smith" "web_url": "http://localhost:3000/janine_smith"
} }
}
] ]
``` ```
......
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