Skip to content

G
gitlab-ce
Commit 5afc9890 authored by Parker Mauney's avatar Parker Mauney Committed by Achilleas Pipinellis
Browse files
Options

Fix missing/trailing JSON commas in API docs 

This adds missing commas and removes invalid trailing commas in
otherwise-valid JSON blocks.
parent dee163de
Hide whitespace changes
Inline Side-by-side
Showing with 41 additions and 41 deletions
doc/api/deployments.md
View file @ 5afc9890
......@@ -266,7 +266,7 @@ Example of response
"status": "success",
"updated_at": "2016-08-11T07:43:52.143Z",
"web_url": "http://gitlab.dev/root/project/pipelines/5"
}
},
"runner": null
}
}
......
doc/api/discussions.md
View file @ 5afc9890
......@@ -787,12 +787,12 @@ Diff comments also contain position:
"line_range": {
"start": {
"line_code": "588440f66559714280628a4f9799f0c4eb880a4a_10_10",
"type": "new",
"type": "new"
},
"end": {
"line_code": "588440f66559714280628a4f9799f0c4eb880a4a_11_11",
"type": "old"
},
}
}
},
"resolved": false,
......
doc/api/epic_links.md
View file @ 5afc9890
......@@ -97,7 +97,7 @@ Example response:
"id": 6,
"iid": 38,
"group_id": 1,
"parent_id": 5
"parent_id": 5,
"title": "Accusamus iste et ullam ratione voluptatem omnis debitis dolor est.",
"description": "Molestias dolorem eos vitae expedita impedit necessitatibus quo voluptatum.",
"author": {
......
doc/api/events.md
View file @ 5afc9890
......@@ -301,7 +301,7 @@ Example response:
```json
[
{
"id": 8
"id": 8,
"title":null,
"project_id":1,
"action_name":"opened",
......
doc/api/feature_flag_user_lists.md
View file @ 5afc9890
......@@ -126,7 +126,7 @@ Example response:
"iid": 1,
"project_id": 1,
"created_at": "2020-02-04T08:13:10.507Z",
"updated_at": "2020-02-04T08:13:10.507Z",
"updated_at": "2020-02-04T08:13:10.507Z"
}
```
......
doc/api/feature_flags.md
View file @ 5afc9890
......@@ -70,7 +70,7 @@ Example response:
"version": "new_version_flag",
"created_at":"2019-11-04T08:13:10.507Z",
"updated_at":"2019-11-04T08:13:10.507Z",
"scopes":[]
"scopes":[],
"strategies": [
{
"id": 2,
......
doc/api/group_badges.md
View file @ 5afc9890
......@@ -192,6 +192,6 @@ Example response:
"link_url": "http://example.com/ci_status.svg?project=%{project_path}&ref=%{default_branch}",
"image_url": "https://shields.io/my/badge",
"rendered_link_url": "http://example.com/ci_status.svg?project=example-org/example-project&ref=master",
"rendered_image_url": "https://shields.io/my/badge",
"rendered_image_url": "https://shields.io/my/badge"
}
```
doc/api/groups.md
View file @ 5afc9890
......@@ -101,7 +101,7 @@ GET /groups?statistics=true
"lfs_objects_size" : 123,
"job_artifacts_size" : 57,
"packages_size": 0,
"snippets_size" : 50,
"snippets_size" : 50
}
}
]
......
doc/api/instance_clusters.md
View file @ 5afc9890
......@@ -84,7 +84,7 @@ Example response:
},
"provider_gcp": null,
"management_project": null
}
},
{
"id": 11,
"name": "cluster-3",
......
doc/api/issue_links.md
View file @ 5afc9890
......@@ -117,7 +117,7 @@ Example response:
"due_date": null,
"web_url": "http://example.com/example/example/issues/11",
"confidential": false,
"weight": null,
"weight": null
},
"target_issue" : {
"id" : 84,
......@@ -147,7 +147,7 @@ Example response:
"due_date": null,
"web_url": "http://example.com/example/example/issues/14",
"confidential": false,
"weight": null,
"weight": null
},
"link_type": "relates_to"
}
......@@ -198,7 +198,7 @@ DELETE /projects/:id/issues/:issue_iid/links/:issue_link_id
"due_date": null,
"web_url": "http://example.com/example/example/issues/11",
"confidential": false,
"weight": null,
"weight": null
},
"target_issue" : {
"id" : 84,
......@@ -228,7 +228,7 @@ DELETE /projects/:id/issues/:issue_iid/links/:issue_link_id
"due_date": null,
"web_url": "http://example.com/example/example/issues/14",
"confidential": false,
"weight": null,
"weight": null
},
"link_type": "relates_to"
}
......
doc/api/keys.md
View file @ 5afc9890
......@@ -31,7 +31,7 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/a
"title": "Sample key 25",
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt1256k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=",
"created_at": "2015-09-03T07:24:44.627Z",
"expires_at": "2020-05-05T00:00:00.000Z"
"expires_at": "2020-05-05T00:00:00.000Z",
"user": {
"name": "John Smith",
"username": "john_smith",
......@@ -59,7 +59,7 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/a
"identities": [],
"can_create_group": true,
"can_create_project": true,
"two_factor_enabled": false
"two_factor_enabled": false,
"external": false,
"private_profile": null
}
......@@ -100,7 +100,7 @@ Example response:
"title": "Sample key 1",
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt1016k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=",
"created_at": "2019-11-14T15:11:13.222Z",
"expires_at": "2020-05-05T00:00:00.000Z"
"expires_at": "2020-05-05T00:00:00.000Z",
"user": {
"id": 1,
"name": "Administrator",
......
doc/api/license.md
View file @ 5afc9890
......@@ -80,7 +80,7 @@ GET /licenses
"Name": "Doe John"
},
"add_ons": {
"GitLab_FileLocks": 1,
"GitLab_FileLocks": 1
}
}
]
......
doc/api/members.md
View file @ 5afc9890
......@@ -136,7 +136,7 @@ Example response:
"avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon",
"web_url": "http://192.168.1.8:3000/root",
"expires_at": "2012-10-22T14:13:35Z",
"access_level": 30
"access_level": 30,
"email": "john@example.com",
"group_saml_identity": {
"extern_uid":"ABC-1234567890",
......
doc/api/merge_request_approvals.md
View file @ 5afc9890
......@@ -664,7 +664,7 @@ GET /projects/:id/merge_requests/:merge_request_iid/approvals
"web_url": "http://localhost:3000/root"
}
}
],
]
}
```
......@@ -1109,7 +1109,7 @@ does not match, the response code is `409`.
"web_url": "http://localhost:3000/ryley"
}
}
],
]
}
```
......
doc/api/merge_requests.md
View file @ 5afc9890
......@@ -2319,7 +2319,7 @@ Example response:
"short": "!1",
"relative": "!1",
"full": "my-group/my-project!1"
},
}
},
"target_url": "https://gitlab.example.com/gitlab-org/gitlab-ci/merge_requests/7",
"body": "Et voluptas laudantium minus nihil recusandae ut accusamus earum aut non.",
......
doc/api/pipeline_schedules.md
View file @ 5afc9890
......@@ -370,8 +370,8 @@ curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" --form "value=u
```json
{
"key": "NEW_VARIABLE",
"value": "updated value"
"variable_type": "env_var",
"value": "updated value",
"variable_type": "env_var"
}
```
......
doc/api/pipelines.md
View file @ 5afc9890
......@@ -60,7 +60,7 @@ Example of response
"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",
"updated_at": "2016-08-11T11:32:35.169Z"
},
{
"id": 48,
......@@ -70,7 +70,7 @@ Example of response
"sha": "eb94b618fb5865b26e80fdd8ae531b7a63ad851a",
"web_url": "https://example.com/foo/bar/pipelines/48",
"created_at": "2016-08-12T10:06:04.561Z",
"updated_at": "2016-08-12T10:09:56.223Z",
"updated_at": "2016-08-12T10:09:56.223Z"
}
]
```
......
doc/api/project_badges.md
View file @ 5afc9890
......@@ -59,7 +59,7 @@ Example response:
"rendered_link_url": "http://example.com/ci_status.svg?project=example-org/example-project&ref=master",
"rendered_image_url": "https://shields.io/my/badge",
"kind": "group"
},
}
]
```
......@@ -202,6 +202,6 @@ Example response:
"link_url": "http://example.com/ci_status.svg?project=%{project_path}&ref=%{default_branch}",
"image_url": "https://shields.io/my/badge",
"rendered_link_url": "http://example.com/ci_status.svg?project=example-org/example-project&ref=master",
"rendered_image_url": "https://shields.io/my/badge",
"rendered_image_url": "https://shields.io/my/badge"
}
```
doc/api/project_import_export.md
View file @ 5afc9890
......@@ -104,7 +104,7 @@ an email notifying the user to download the file, uploading the exported file to
"export_status": "finished",
"_links": {
"api_url": "https://gitlab.example.com/api/v4/projects/1/export/download",
"web_url": "https://gitlab.example.com/gitlab-org/gitlab-test/download_export",
"web_url": "https://gitlab.example.com/gitlab-org/gitlab-test/download_export"
}
}
```
......
doc/api/project_snippets.md
View file @ 5afc9890
......@@ -114,7 +114,7 @@ curl --request POST "https://gitlab.com/api/v4/projects/:id/snippets" \
"files": [
{
"file_path": "example.txt",
"content" : "source code \n with multiple lines\n",
"content" : "source code \n with multiple lines\n"
}
]
}
......
doc/api/projects.md
View file @ 5afc9890
......@@ -94,7 +94,7 @@ When `simple=true` or the user is unauthenticated this returns something like:
"last_activity_at": "2013-09-30T13:46:02Z",
"forks_count": 0,
"avatar_url": "http://example.com/uploads/project/avatar/4/uploads/avatar.png",
"star_count": 0,
"star_count": 0
},
{
"id": 6,
......@@ -189,7 +189,7 @@ When the user is authenticated and `simple` is not set this returns something li
"labels": "http://example.com/api/v4/projects/1/labels",
"events": "http://example.com/api/v4/projects/1/events",
"members": "http://example.com/api/v4/projects/1/members"
},
}
},
{
"id": 6,
......@@ -986,7 +986,7 @@ If the project is a fork, and you provide a valid token to authenticate, the
"name": "MIT License",
"nickname": null,
"html_url": "http://choosealicense.com/licenses/mit/",
"source_url": "https://opensource.org/licenses/MIT",
"source_url": "https://opensource.org/licenses/MIT"
},
"star_count":3812,
"forks_count":3561,
......
doc/api/releases/index.md
View file @ 5afc9890
......@@ -482,7 +482,7 @@ Example response:
}
],
"evidence_file_path":"https://gitlab.example.com/root/awesome-app/-/releases/v0.3/evidence.json"
},
}
}
```
......@@ -625,7 +625,7 @@ Example response:
],
"evidence_file_path":"https://gitlab.example.com/root/awesome-app/-/releases/v0.1/evidence.json"
},
}
}
```
......@@ -709,7 +709,7 @@ Example response:
],
"evidence_file_path":"https://gitlab.example.com/root/awesome-app/-/releases/v0.1/evidence.json"
},
}
}
```
......
doc/api/runners.md
View file @ 5afc9890
......@@ -126,7 +126,7 @@ Example response:
"ip_address": "127.0.0.1",
"is_shared": true,
"name": null,
"online": false
"online": false,
"status": "offline"
},
{
......@@ -136,7 +136,7 @@ Example response:
"ip_address": "127.0.0.1",
"is_shared": false,
"name": null,
"online": true
"online": true,
"status": "paused"
},
{
......@@ -428,7 +428,7 @@ Example response:
"ip_address": "127.0.0.1",
"is_shared": true,
"name": null,
"online": true
"online": true,
"status": "paused"
}
]
......
doc/api/services.md
View file @ 5afc9890
......@@ -42,7 +42,7 @@ Example response:
"wiki_page_events": true,
"job_events": true,
"comment_on_event_enabled": true
}
},
{
"id": 76,
"title": "Alerts endpoint",
......
doc/api/users.md
View file @ 5afc9890
......@@ -1762,6 +1762,6 @@ Example response:
"source_name": "Group three",
"source_type": "Namespace",
"access_level": "20"
},
}
]
```
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
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7