diff options
author | Johannes Schleifenbaum <johannes@js-webcoding.de> | 2014-04-05 10:36:47 +0400 |
---|---|---|
committer | Johannes Schleifenbaum <johannes@js-webcoding.de> | 2014-04-05 10:37:42 +0400 |
commit | 49addad7b5f18776dbd593f628237736e638b28c (patch) | |
tree | 76f4b72c20dd8e92d596dd619791e81076d79fd0 | |
parent | 1f1cfc9eba6d9b60decb4fcd0645fcbfd288925f (diff) |
Api-Doc JSON lint
Fixes: #5505
-rw-r--r-- | doc/api/branches.md | 29 | ||||
-rw-r--r-- | doc/api/commits.md | 6 | ||||
-rw-r--r-- | doc/api/deploy_keys.md | 24 | ||||
-rw-r--r-- | doc/api/issues.md | 2 | ||||
-rw-r--r-- | doc/api/merge_requests.md | 259 | ||||
-rw-r--r-- | doc/api/milestones.md | 18 | ||||
-rw-r--r-- | doc/api/notes.md | 94 | ||||
-rw-r--r-- | doc/api/projects.md | 150 | ||||
-rw-r--r-- | doc/api/repositories.md | 75 | ||||
-rw-r--r-- | doc/api/repository_files.md | 6 | ||||
-rw-r--r-- | doc/api/session.md | 6 | ||||
-rw-r--r-- | doc/api/system_hooks.md | 18 | ||||
-rw-r--r-- | doc/api/users.md | 22 |
13 files changed, 355 insertions, 354 deletions
diff --git a/doc/api/branches.md b/doc/api/branches.md index 3417a695077..da9d4193f20 100644 --- a/doc/api/branches.md +++ b/doc/api/branches.md @@ -181,18 +181,21 @@ Parameters: ```json { - "name": "my-new-branch", - "commit": { - "id": "8848c0e90327a0b70f1865b843fb2fbfb9345e57", - "message": "Merge pull request #54 from brightbox/use_fog_brightbox_module\n\nUpdate to use fog-brightbox module", - "parent_ids": ["fff449e0bf453576f16c91d6544f00a2664009d8", "f93a93626fec20fd659f4ed3ab2e64019b6169ae"], - "authored_date": "2014-02-20T19:54:55+02:00", - "author_name": "john smith", - "author_email": "john@example.com", - "committed_date": "2014-02-20T19:54:55+02:00", - "committer_name": "john smith", - "committer_email": "john@example.com" - }, - "protected": false + "name": "my-new-branch", + "commit": { + "id": "8848c0e90327a0b70f1865b843fb2fbfb9345e57", + "message": "Merge pull request #54 from brightbox/use_fog_brightbox_module\n\nUpdate to use fog-brightbox module", + "parent_ids": [ + "fff449e0bf453576f16c91d6544f00a2664009d8", + "f93a93626fec20fd659f4ed3ab2e64019b6169ae" + ], + "authored_date": "2014-02-20T19:54:55+02:00", + "author_name": "john smith", + "author_email": "john@example.com", + "committed_date": "2014-02-20T19:54:55+02:00", + "committer_name": "john smith", + "committer_email": "john@example.com" + }, + "protected": false } ``` diff --git a/doc/api/commits.md b/doc/api/commits.md index 69b44a2e83b..241fe0e585a 100644 --- a/doc/api/commits.md +++ b/doc/api/commits.md @@ -57,9 +57,9 @@ Parameters: "created_at": "2012-09-20T09:06:12+03:00", "committed_date": "2012-09-20T09:06:12+03:00", "authored_date": "2012-09-20T09:06:12+03:00", - "parent_ids" : [ - "ae1d9fb46aa2b07ee9836d49862ec4e2c46fbbba" - ] + "parent_ids": [ + "ae1d9fb46aa2b07ee9836d49862ec4e2c46fbbba" + ] } ``` diff --git a/doc/api/deploy_keys.md b/doc/api/deploy_keys.md index 50d2b82c36f..d6c0e624dfb 100644 --- a/doc/api/deploy_keys.md +++ b/doc/api/deploy_keys.md @@ -16,19 +16,15 @@ Parameters: [ { "id": 1, - "title" : "Public key", - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4 - 596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4 - soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=", - "created_at":"2013-10-02T10:12:29Z" + "title": "Public key", + "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=", + "created_at": "2013-10-02T10:12:29Z" }, { "id": 3, - "title" : "Another Public key", - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4 - 596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4 - soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=", - "created_at":"2013-10-02T11:12:29Z" + "title": "Another Public key", + "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=", + "created_at": "2013-10-02T11:12:29Z" } ] ``` @@ -50,11 +46,9 @@ Parameters: ```json { "id": 1, - "title" : "Public key", - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4 - 596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4 - soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=", - "created_at":"2013-10-02T10:12:29Z" + "title": "Public key", + "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=", + "created_at": "2013-10-02T10:12:29Z" } ``` diff --git a/doc/api/issues.md b/doc/api/issues.md index ef37940faf0..823b72f5b0c 100644 --- a/doc/api/issues.md +++ b/doc/api/issues.md @@ -15,7 +15,7 @@ GET /issues "project_id": 8, "title": "4xx/5xx pages", "description": "", - "labels": [ ], + "labels": [], "milestone": null, "assignee": null, "author": { diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md index 3ce0fb84917..483c4188713 100644 --- a/doc/api/merge_requests.md +++ b/doc/api/merge_requests.md @@ -13,33 +13,33 @@ Parameters: ```json [ - { - "id":1, - "iid":1, - "target_branch":"master", - "source_branch":"test1", - "project_id":3, - "title":"test1", - "state":"opened", - "upvotes":0, - "downvotes":0, - "author":{ - "id":1, - "username": "admin", - "email":"admin@local.host", - "name":"Administrator", - "state":"active", - "created_at":"2012-04-29T08:46:00Z" - }, - "assignee":{ - "id":1, - "username": "admin", - "email":"admin@local.host", - "name":"Administrator", - "state":"active", - "created_at":"2012-04-29T08:46:00Z" - } + { + "id": 1, + "iid": 1, + "target_branch": "master", + "source_branch": "test1", + "project_id": 3, + "title": "test1", + "state": "opened", + "upvotes": 0, + "downvotes": 0, + "author": { + "id": 1, + "username": "admin", + "email": "admin@local.host", + "name": "Administrator", + "state": "active", + "created_at": "2012-04-29T08:46:00Z" + }, + "assignee": { + "id": 1, + "username": "admin", + "email": "admin@local.host", + "name": "Administrator", + "state": "active", + "created_at": "2012-04-29T08:46:00Z" } + } ] ``` @@ -59,31 +59,31 @@ Parameters: ```json { - "id":1, - "iid":1, - "target_branch":"master", - "source_branch":"test1", - "project_id":3, - "title":"test1", - "state":"merged", - "upvotes":0, - "downvotes":0, - "author":{ - "id":1, - "username": "admin", - "email":"admin@local.host", - "name":"Administrator", - "state":"active", - "created_at":"2012-04-29T08:46:00Z" - }, - "assignee":{ - "id":1, - "username": "admin", - "email":"admin@local.host", - "name":"Administrator", - "state":"active", - "created_at":"2012-04-29T08:46:00Z" - } + "id": 1, + "iid": 1, + "target_branch": "master", + "source_branch": "test1", + "project_id": 3, + "title": "test1", + "state": "merged", + "upvotes": 0, + "downvotes": 0, + "author": { + "id": 1, + "username": "admin", + "email": "admin@local.host", + "name": "Administrator", + "state": "active", + "created_at": "2012-04-29T08:46:00Z" + }, + "assignee": { + "id": 1, + "username": "admin", + "email": "admin@local.host", + "name": "Administrator", + "state": "active", + "created_at": "2012-04-29T08:46:00Z" + } } ``` @@ -106,30 +106,30 @@ Parameters: ```json { - "id":1, - "target_branch":"master", - "source_branch":"test1", - "project_id":3, - "title":"test1", - "state":"opened", - "upvotes":0, - "downvotes":0, - "author":{ - "id":1, - "username": "admin", - "email":"admin@local.host", - "name":"Administrator", - "state":"active", - "created_at":"2012-04-29T08:46:00Z" - }, - "assignee":{ - "id":1, - "username": "admin", - "email":"admin@local.host", - "name":"Administrator", - "state":"active", - "created_at":"2012-04-29T08:46:00Z" - } + "id": 1, + "target_branch": "master", + "source_branch": "test1", + "project_id": 3, + "title": "test1", + "state": "opened", + "upvotes": 0, + "downvotes": 0, + "author": { + "id": 1, + "username": "admin", + "email": "admin@local.host", + "name": "Administrator", + "state": "active", + "created_at": "2012-04-29T08:46:00Z" + }, + "assignee": { + "id": 1, + "username": "admin", + "email": "admin@local.host", + "name": "Administrator", + "state": "active", + "created_at": "2012-04-29T08:46:00Z" + } } ``` @@ -153,32 +153,31 @@ Parameters: + `state_event` - New state (close|reopen|merge) ```json - { - "id":1, - "target_branch":"master", - "source_branch":"test1", - "project_id":3, - "title":"test1", - "state":"opened", - "upvotes":0, - "downvotes":0, - "author":{ - "id":1, - "username": "admin", - "email":"admin@local.host", - "name":"Administrator", - "state":"active", - "created_at":"2012-04-29T08:46:00Z" - }, - "assignee":{ - "id":1, - "username": "admin", - "email":"admin@local.host", - "name":"Administrator", - "state":"active", - "created_at":"2012-04-29T08:46:00Z" - } + "id": 1, + "target_branch": "master", + "source_branch": "test1", + "project_id": 3, + "title": "test1", + "state": "opened", + "upvotes": 0, + "downvotes": 0, + "author": { + "id": 1, + "username": "admin", + "email": "admin@local.host", + "name": "Administrator", + "state": "active", + "created_at": "2012-04-29T08:46:00Z" + }, + "assignee": { + "id": 1, + "username": "admin", + "email": "admin@local.host", + "name": "Administrator", + "state": "active", + "created_at": "2012-04-29T08:46:00Z" + } } ``` @@ -200,15 +199,15 @@ Parameters: ```json { - "author":{ - "id":1, - "username": "admin", - "email":"admin@local.host", - "name":"Administrator", - "blocked":false, - "created_at":"2012-04-29T08:46:00Z" - }, - "note":"text1" + "author": { + "id": 1, + "username": "admin", + "email": "admin@local.host", + "name": "Administrator", + "blocked": false, + "created_at": "2012-04-29T08:46:00Z" + }, + "note": "text1" } ``` @@ -228,27 +227,27 @@ Parameters: ```json [ - { - "note":"this is the 1st comment on the 2merge merge request", - "author":{ - "id":11, - "username":"admin", - "email":"admin@local.host", - "name":"Administrator", - "state":"active", - "created_at":"2014-03-06T08:17:35.000Z" - } - }, - { - "note":"_Status changed to closed_", - "author":{ - "id":11, - "username":"admin", - "email":"admin@local.host", - "name":"Administrator", - "state":"active", - "created_at":"2014-03-06T08:17:35.000Z" - } + { + "note": "this is the 1st comment on the 2merge merge request", + "author": { + "id": 11, + "username": "admin", + "email": "admin@local.host", + "name": "Administrator", + "state": "active", + "created_at": "2014-03-06T08:17:35.000Z" + } + }, + { + "note": "_Status changed to closed_", + "author": { + "id": 11, + "username": "admin", + "email": "admin@local.host", + "name": "Administrator", + "state": "active", + "created_at": "2014-03-06T08:17:35.000Z" } + } ] ``` diff --git a/doc/api/milestones.md b/doc/api/milestones.md index e899e28d219..2a2ef4b79b1 100644 --- a/doc/api/milestones.md +++ b/doc/api/milestones.md @@ -9,15 +9,15 @@ GET /projects/:id/milestones ```json [ { - "id":12, - "iid":3, - "project_id":16, - "title":"10.0", - "description":"Version", - "due_date":"2013-11-29", - "state":"active", - "updated_at":"2013-10-02T09:24:18Z", - "created_at":"2013-10-02T09:24:18Z" + "id": 12, + "iid": 3, + "project_id": 16, + "title": "10.0", + "description": "Version", + "due_date": "2013-11-29", + "state": "active", + "updated_at": "2013-10-02T09:24:18Z", + "created_at": "2013-10-02T09:24:18Z" } ] ``` diff --git a/doc/api/notes.md b/doc/api/notes.md index 397aa87aadf..b15ebdd2bac 100644 --- a/doc/api/notes.md +++ b/doc/api/notes.md @@ -17,7 +17,7 @@ Parameters: { "id": 522, "body": "The solution is rather tricky", - "attachment":null, + "attachment": null, "author": { "id": 1, "username": "john_smith", @@ -77,32 +77,32 @@ Parameters: ```json [ { - "id":302, - "body":"_Status changed to closed_", - "attachment":null, - "author":{ - "id":1, - "username":"pipin", - "email":"admin@example.com", - "name":"Pip", - "state":"active", - "created_at":"2013-09-30T13:46:01Z" + "id": 302, + "body": "_Status changed to closed_", + "attachment": null, + "author": { + "id": 1, + "username": "pipin", + "email": "admin@example.com", + "name": "Pip", + "state": "active", + "created_at": "2013-09-30T13:46:01Z" }, - "created_at":"2013-10-02T09:22:45Z" + "created_at": "2013-10-02T09:22:45Z" }, { - "id":305, - "body":"Text of the comment\r\n", - "attachment":null, - "author":{ - "id":1, - "username":"pipin", - "email":"admin@example.com", - "name":"Pip", - "state":"active", - "created_at":"2013-09-30T13:46:01Z" + "id": 305, + "body": "Text of the comment\r\n", + "attachment": null, + "author": { + "id": 1, + "username": "pipin", + "email": "admin@example.com", + "name": "Pip", + "state": "active", + "created_at": "2013-09-30T13:46:01Z" }, - "created_at":"2013-10-02T09:56:03Z" + "created_at": "2013-10-02T09:56:03Z" } ] ``` @@ -169,20 +169,20 @@ Parameters: ```json { - "id":52, - "title":"Snippet", - "file_name":"snippet.rb", - "author":{ - "id":1, - "username":"pipin", - "email":"admin@example.com", - "name":"Pip", - "state":"active", - "created_at":"2013-09-30T13:46:01Z" + "id": 52, + "title": "Snippet", + "file_name": "snippet.rb", + "author": { + "id": 1, + "username": "pipin", + "email": "admin@example.com", + "name": "Pip", + "state": "active", + "created_at": "2013-09-30T13:46:01Z" }, - "expires_at":null, - "updated_at":"2013-10-02T07:34:20Z", - "created_at":"2013-10-02T07:34:20Z" + "expires_at": null, + "updated_at": "2013-10-02T07:34:20Z", + "created_at": "2013-10-02T07:34:20Z" } ``` @@ -233,18 +233,18 @@ Parameters: ```json { - "id":301, - "body":"Comment for MR", - "attachment":null, - "author":{ - "id":1, - "username":"pipin", - "email":"admin@example.com", - "name":"Pip", - "state":"active", - "created_at":"2013-09-30T13:46:01Z" + "id": 301, + "body": "Comment for MR", + "attachment": null, + "author": { + "id": 1, + "username": "pipin", + "email": "admin@example.com", + "name": "Pip", + "state": "active", + "created_at": "2013-09-30T13:46:01Z" }, - "created_at":"2013-10-02T08:57:14Z" + "created_at": "2013-10-02T08:57:14Z" } ``` diff --git a/doc/api/projects.md b/doc/api/projects.md index 54618d7c045..40bcc6e2cd4 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -54,7 +54,7 @@ GET /projects "ssh_url_to_repo": "git@example.com:brightbox/puppet.git", "http_url_to_repo": "http://example.com/brightbox/puppet.git", "web_url": "http://example.com/brightbox/puppet", - "owner": { + "owner": { "id": 4, "name": "Brightbox", "created_at": "2013-09-30T13:46:02Z" @@ -70,7 +70,7 @@ GET /projects "snippets_enabled": false, "created_at": "2013-09-30T13:46:02Z", "last_activity_at": "2013-09-30T13:46:02Z", - "namespace": { + "namespace": { "created_at": "2013-09-30T13:46:02Z", "description": "", "id": 4, @@ -147,7 +147,7 @@ Parameters: "owner_id": 1, "path": "diaspora", "updated_at": "2013-09-30T13: 46: 02Z" - } + }, "permissions": { "project_access": { "access_level": 10, @@ -175,58 +175,63 @@ Parameters: + `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project ```json - -[{ - "title": null, - "project_id": 15, - "action_name": "closed", - "target_id": 830, - "target_type": "Issue", - "author_id": 1, - "data": null, - "target_title": "Public project search field" -}, { - "title": null, - "project_id": 15, - "action_name": "opened", - "target_id": null, - "target_type": null, - "author_id": 1, - "data": { - "before": "50d4420237a9de7be1304607147aec22e4a14af7", - "after": "c5feabde2d8cd023215af4d2ceeb7a64839fc428", - "ref": "refs/heads/master", - "user_id": 1, - "user_name": "Dmitriy Zaporozhets", - "repository": { - "name": "gitlabhq", - "url": "git@dev.gitlab.org:gitlab/gitlabhq.git", - "description": "GitLab: self hosted Git management software. \r\nDistributed under the MIT License.", - "homepage": "https://dev.gitlab.org/gitlab/gitlabhq" +[ + { + "title": null, + "project_id": 15, + "action_name": "closed", + "target_id": 830, + "target_type": "Issue", + "author_id": 1, + "data": null, + "target_title": "Public project search field" + }, + { + "title": null, + "project_id": 15, + "action_name": "opened", + "target_id": null, + "target_type": null, + "author_id": 1, + "data": { + "before": "50d4420237a9de7be1304607147aec22e4a14af7", + "after": "c5feabde2d8cd023215af4d2ceeb7a64839fc428", + "ref": "refs/heads/master", + "user_id": 1, + "user_name": "Dmitriy Zaporozhets", + "repository": { + "name": "gitlabhq", + "url": "git@dev.gitlab.org:gitlab/gitlabhq.git", + "description": "GitLab: self hosted Git management software. \r\nDistributed under the MIT License.", + "homepage": "https://dev.gitlab.org/gitlab/gitlabhq" + }, + "commits": [ + { + "id": "c5feabde2d8cd023215af4d2ceeb7a64839fc428", + "message": "Add simple search to projects in public area", + "timestamp": "2013-05-13T18:18:08+00:00", + "url": "https://dev.gitlab.org/gitlab/gitlabhq/commit/c5feabde2d8cd023215af4d2ceeb7a64839fc428", + "author": { + "name": "Dmitriy Zaporozhets", + "email": "dmitriy.zaporozhets@gmail.com" + } + } + ], + "total_commits_count": 1 }, - "commits": [{ - "id": "c5feabde2d8cd023215af4d2ceeb7a64839fc428", - "message": "Add simple search to projects in public area", - "timestamp": "2013-05-13T18:18:08+00:00", - "url": "https://dev.gitlab.org/gitlab/gitlabhq/commit/c5feabde2d8cd023215af4d2ceeb7a64839fc428", - "author": { - "name": "Dmitriy Zaporozhets", - "email": "dmitriy.zaporozhets@gmail.com" - } - }], - "total_commits_count": 1 + "target_title": null }, - "target_title": null -}, { - "title": null, - "project_id": 15, - "action_name": "closed", - "target_id": 840, - "target_type": "Issue", - "author_id": 1, - "data": null, - "target_title": "Finish & merge Code search PR" -}] + { + "title": null, + "project_id": 15, + "action_name": "closed", + "target_id": 840, + "target_type": "Issue", + "author_id": 1, + "data": null, + "target_title": "Finish & merge Code search PR" + } +] ``` @@ -493,34 +498,38 @@ Parameters: ```json [ { - "name":"async", + "name": "async", "commit": { - "id":"a2b702edecdf41f07b42653eb1abe30ce98b9fca", - "parents": [{ - "id":"3f94fc7c85061973edc9906ae170cc269b07ca55" - }], + "id": "a2b702edecdf41f07b42653eb1abe30ce98b9fca", + "parents": [ + { + "id": "3f94fc7c85061973edc9906ae170cc269b07ca55" + } + ], "tree": "c68537c6534a02cc2b176ca1549f4ffa190b58ee", - "message":"give caolan credit where it's due (up top)", + "message": "give caolan credit where it's due (up top)", "author": { - "name":"Jeremy Ashkenas", - "email":"jashkenas@example.com" + "name": "Jeremy Ashkenas", + "email": "jashkenas@example.com" }, "committer": { - "name":"Jeremy Ashkenas", - "email":"jashkenas@example.com" + "name": "Jeremy Ashkenas", + "email": "jashkenas@example.com" }, - "authored_date":"2010-12-08T21:28:50+00:00", - "committed_date":"2010-12-08T21:28:50+00:00" + "authored_date": "2010-12-08T21:28:50+00:00", + "committed_date": "2010-12-08T21:28:50+00:00" }, - "protected":false + "protected": false }, { "name": "gh-pages", "commit": { "id": "101c10a60019fe870d21868835f65c25d64968fc", - "parents": [{ - "id": "9c15d2e26945a665131af5d7b6d30a06ba338aaa" - }], + "parents": [ + { + "id": "9c15d2e26945a665131af5d7b6d30a06ba338aaa" + } + ], "tree": "fb5cc9d45da3014b17a876ad539976a0fb9b352a", "message": "Underscore.js 1.5.2", "author": { @@ -537,7 +546,6 @@ Parameters: "protected": false } ] - ``` ### List single branch @@ -640,7 +648,7 @@ Parameters: ```json [ { - "name":"featute" + "name": "feature" }, { "name": "bug" diff --git a/doc/api/repositories.md b/doc/api/repositories.md index 3b042e14e72..858fad0a0b5 100644 --- a/doc/api/repositories.md +++ b/doc/api/repositories.md @@ -16,9 +16,7 @@ Parameters: "name": "v1.0.0", "commit": { "id": "2695effb5807a22ff3d138d593fd856244e155e7", - "parents": [ - - ], + "parents": [], "tree": "38017f2f189336fe4497e9d230c5bb1bf873f08d", "message": "Initial commit", "author": { @@ -52,39 +50,44 @@ Parameters: + `ref_name` (optional) - The name of a repository branch or tag or if not given the default branch ```json - -[{ - "name": "assets", - "type": "tree", - "mode": "040000", - "id": "6229c43a7e16fcc7e95f923f8ddadb8281d9c6c6" -}, { - "name": "contexts", - "type": "tree", - "mode": "040000", - "id": "faf1cdf33feadc7973118ca42d35f1e62977e91f" -}, { - "name": "controllers", - "type": "tree", - "mode": "040000", - "id": "95633e8d258bf3dfba3a5268fb8440d263218d74" -}, { - "name": "Rakefile", - "type": "blob", - "mode": "100644", - "id": "35b2f05cbb4566b71b34554cf184a9d0bd9d46d6" -}, { - "name": "VERSION", - "type": "blob", - "mode": "100644", - "id": "803e4a4f3727286c3093c63870c2b6524d30ec4f" -}, { - "name": "config.ru", - "type": "blob", - "mode": "100644", - "id": "dfd2d862237323aa599be31b473d70a8a817943b" -}] - +[ + { + "name": "assets", + "type": "tree", + "mode": "040000", + "id": "6229c43a7e16fcc7e95f923f8ddadb8281d9c6c6" + }, + { + "name": "contexts", + "type": "tree", + "mode": "040000", + "id": "faf1cdf33feadc7973118ca42d35f1e62977e91f" + }, + { + "name": "controllers", + "type": "tree", + "mode": "040000", + "id": "95633e8d258bf3dfba3a5268fb8440d263218d74" + }, + { + "name": "Rakefile", + "type": "blob", + "mode": "100644", + "id": "35b2f05cbb4566b71b34554cf184a9d0bd9d46d6" + }, + { + "name": "VERSION", + "type": "blob", + "mode": "100644", + "id": "803e4a4f3727286c3093c63870c2b6524d30ec4f" + }, + { + "name": "config.ru", + "type": "blob", + "mode": "100644", + "id": "dfd2d862237323aa599be31b473d70a8a817943b" + } +] ``` diff --git a/doc/api/repository_files.md b/doc/api/repository_files.md index cafab8c828f..b215cc25001 100644 --- a/doc/api/repository_files.md +++ b/doc/api/repository_files.md @@ -44,7 +44,7 @@ Example response: ```json { "file_name": "app/project.rb", - "branch_name": "master", + "branch_name": "master" } ``` @@ -67,7 +67,7 @@ Example response: ```json { "file_name": "app/project.rb", - "branch_name": "master", + "branch_name": "master" } ``` @@ -90,7 +90,7 @@ Example response: ```json { "file_name": "app/project.rb", - "branch_name": "master", + "branch_name": "master" } ``` diff --git a/doc/api/session.md b/doc/api/session.md index fd18d5c5e97..0be5af79dad 100644 --- a/doc/api/session.md +++ b/doc/api/session.md @@ -30,8 +30,8 @@ __You can login with both GitLab and LDAP credentials now__ "dark_scheme": false, "theme_id": 1, "is_admin": false, - "can_create_group" : true, - "can_create_team" : true, - "can_create_project" : true + "can_create_group": true, + "can_create_team": true, + "can_create_project": true } ``` diff --git a/doc/api/system_hooks.md b/doc/api/system_hooks.md index 2e87ada1d70..d4c45ea9bbd 100644 --- a/doc/api/system_hooks.md +++ b/doc/api/system_hooks.md @@ -17,9 +17,9 @@ Parameters: ```json [ { - "id":3, - "url":"http://example.com/hook", - "created_at":"2013-10-02T10:15:31Z" + "id": 3, + "url": "http://example.com/hook", + "created_at": "2013-10-02T10:15:31Z" } ] ``` @@ -47,12 +47,12 @@ Parameters: ```json { - "event_name":"project_create", - "name":"Ruby", - "path":"ruby", - "project_id":1, - "owner_name":"Someone", - "owner_email":"example@gitlabhq.com" + "event_name": "project_create", + "name": "Ruby", + "path": "ruby", + "project_id": 1, + "owner_name": "Someone", + "owner_email": "example@gitlabhq.com" } ``` diff --git a/doc/api/users.md b/doc/api/users.md index 1b9eecf2159..2d5dedb3a39 100644 --- a/doc/api/users.md +++ b/doc/api/users.md @@ -187,8 +187,8 @@ GET /user "theme_id": 1, "color_scheme_id": 2, "is_admin": false, - "can_create_group" : true, - "can_create_project" : true + "can_create_group": true, + "can_create_project": true } ``` @@ -205,17 +205,13 @@ GET /user/keys [ { "id": 1, - "title" : "Public key", - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4 - 596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4 - soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=", + "title": "Public key", + "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=" }, { "id": 3, - "title" : "Another Public key", - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4 - 596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4 - soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=" + "title": "Another Public key", + "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=" } ] ``` @@ -240,10 +236,8 @@ Parameters: ```json { "id": 1, - "title" : "Public key", - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4 - 596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4 - soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=" + "title": "Public key", + "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=" } ``` |