Skip to content

G
gitlab-ce
Commit 26ab17a8 authored by Sytse Sijbrandij's avatar Sytse Sijbrandij
Browse files
Options

Merge pull request #5508 from jojosch/apidoc-json 

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