Commit 49addad7b5f18776dbd593f628237736e638b28c
1 parent
1f1cfc9e
Exists in
spb-stable
and in
3 other branches
Api-Doc JSON lint
Fixes: #5505
Showing
13 changed files
with
355 additions
and
354 deletions
Show diff stats
doc/api/branches.md
... | ... | @@ -181,18 +181,21 @@ Parameters: |
181 | 181 | |
182 | 182 | ```json |
183 | 183 | { |
184 | - "name": "my-new-branch", | |
185 | - "commit": { | |
186 | - "id": "8848c0e90327a0b70f1865b843fb2fbfb9345e57", | |
187 | - "message": "Merge pull request #54 from brightbox/use_fog_brightbox_module\n\nUpdate to use fog-brightbox module", | |
188 | - "parent_ids": ["fff449e0bf453576f16c91d6544f00a2664009d8", "f93a93626fec20fd659f4ed3ab2e64019b6169ae"], | |
189 | - "authored_date": "2014-02-20T19:54:55+02:00", | |
190 | - "author_name": "john smith", | |
191 | - "author_email": "john@example.com", | |
192 | - "committed_date": "2014-02-20T19:54:55+02:00", | |
193 | - "committer_name": "john smith", | |
194 | - "committer_email": "john@example.com" | |
195 | - }, | |
196 | - "protected": false | |
184 | + "name": "my-new-branch", | |
185 | + "commit": { | |
186 | + "id": "8848c0e90327a0b70f1865b843fb2fbfb9345e57", | |
187 | + "message": "Merge pull request #54 from brightbox/use_fog_brightbox_module\n\nUpdate to use fog-brightbox module", | |
188 | + "parent_ids": [ | |
189 | + "fff449e0bf453576f16c91d6544f00a2664009d8", | |
190 | + "f93a93626fec20fd659f4ed3ab2e64019b6169ae" | |
191 | + ], | |
192 | + "authored_date": "2014-02-20T19:54:55+02:00", | |
193 | + "author_name": "john smith", | |
194 | + "author_email": "john@example.com", | |
195 | + "committed_date": "2014-02-20T19:54:55+02:00", | |
196 | + "committer_name": "john smith", | |
197 | + "committer_email": "john@example.com" | |
198 | + }, | |
199 | + "protected": false | |
197 | 200 | } |
198 | 201 | ``` | ... | ... |
doc/api/commits.md
... | ... | @@ -57,9 +57,9 @@ Parameters: |
57 | 57 | "created_at": "2012-09-20T09:06:12+03:00", |
58 | 58 | "committed_date": "2012-09-20T09:06:12+03:00", |
59 | 59 | "authored_date": "2012-09-20T09:06:12+03:00", |
60 | - "parent_ids" : [ | |
61 | - "ae1d9fb46aa2b07ee9836d49862ec4e2c46fbbba" | |
62 | - ] | |
60 | + "parent_ids": [ | |
61 | + "ae1d9fb46aa2b07ee9836d49862ec4e2c46fbbba" | |
62 | + ] | |
63 | 63 | } |
64 | 64 | ``` |
65 | 65 | ... | ... |
doc/api/deploy_keys.md
... | ... | @@ -16,19 +16,15 @@ Parameters: |
16 | 16 | [ |
17 | 17 | { |
18 | 18 | "id": 1, |
19 | - "title" : "Public key", | |
20 | - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4 | |
21 | - 596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4 | |
22 | - soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=", | |
23 | - "created_at":"2013-10-02T10:12:29Z" | |
19 | + "title": "Public key", | |
20 | + "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=", | |
21 | + "created_at": "2013-10-02T10:12:29Z" | |
24 | 22 | }, |
25 | 23 | { |
26 | 24 | "id": 3, |
27 | - "title" : "Another Public key", | |
28 | - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4 | |
29 | - 596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4 | |
30 | - soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=", | |
31 | - "created_at":"2013-10-02T11:12:29Z" | |
25 | + "title": "Another Public key", | |
26 | + "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=", | |
27 | + "created_at": "2013-10-02T11:12:29Z" | |
32 | 28 | } |
33 | 29 | ] |
34 | 30 | ``` |
... | ... | @@ -50,11 +46,9 @@ Parameters: |
50 | 46 | ```json |
51 | 47 | { |
52 | 48 | "id": 1, |
53 | - "title" : "Public key", | |
54 | - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4 | |
55 | - 596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4 | |
56 | - soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=", | |
57 | - "created_at":"2013-10-02T10:12:29Z" | |
49 | + "title": "Public key", | |
50 | + "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=", | |
51 | + "created_at": "2013-10-02T10:12:29Z" | |
58 | 52 | } |
59 | 53 | ``` |
60 | 54 | ... | ... |
doc/api/issues.md
doc/api/merge_requests.md
... | ... | @@ -13,33 +13,33 @@ Parameters: |
13 | 13 | |
14 | 14 | ```json |
15 | 15 | [ |
16 | - { | |
17 | - "id":1, | |
18 | - "iid":1, | |
19 | - "target_branch":"master", | |
20 | - "source_branch":"test1", | |
21 | - "project_id":3, | |
22 | - "title":"test1", | |
23 | - "state":"opened", | |
24 | - "upvotes":0, | |
25 | - "downvotes":0, | |
26 | - "author":{ | |
27 | - "id":1, | |
28 | - "username": "admin", | |
29 | - "email":"admin@local.host", | |
30 | - "name":"Administrator", | |
31 | - "state":"active", | |
32 | - "created_at":"2012-04-29T08:46:00Z" | |
33 | - }, | |
34 | - "assignee":{ | |
35 | - "id":1, | |
36 | - "username": "admin", | |
37 | - "email":"admin@local.host", | |
38 | - "name":"Administrator", | |
39 | - "state":"active", | |
40 | - "created_at":"2012-04-29T08:46:00Z" | |
41 | - } | |
16 | + { | |
17 | + "id": 1, | |
18 | + "iid": 1, | |
19 | + "target_branch": "master", | |
20 | + "source_branch": "test1", | |
21 | + "project_id": 3, | |
22 | + "title": "test1", | |
23 | + "state": "opened", | |
24 | + "upvotes": 0, | |
25 | + "downvotes": 0, | |
26 | + "author": { | |
27 | + "id": 1, | |
28 | + "username": "admin", | |
29 | + "email": "admin@local.host", | |
30 | + "name": "Administrator", | |
31 | + "state": "active", | |
32 | + "created_at": "2012-04-29T08:46:00Z" | |
33 | + }, | |
34 | + "assignee": { | |
35 | + "id": 1, | |
36 | + "username": "admin", | |
37 | + "email": "admin@local.host", | |
38 | + "name": "Administrator", | |
39 | + "state": "active", | |
40 | + "created_at": "2012-04-29T08:46:00Z" | |
42 | 41 | } |
42 | + } | |
43 | 43 | ] |
44 | 44 | ``` |
45 | 45 | |
... | ... | @@ -59,31 +59,31 @@ Parameters: |
59 | 59 | |
60 | 60 | ```json |
61 | 61 | { |
62 | - "id":1, | |
63 | - "iid":1, | |
64 | - "target_branch":"master", | |
65 | - "source_branch":"test1", | |
66 | - "project_id":3, | |
67 | - "title":"test1", | |
68 | - "state":"merged", | |
69 | - "upvotes":0, | |
70 | - "downvotes":0, | |
71 | - "author":{ | |
72 | - "id":1, | |
73 | - "username": "admin", | |
74 | - "email":"admin@local.host", | |
75 | - "name":"Administrator", | |
76 | - "state":"active", | |
77 | - "created_at":"2012-04-29T08:46:00Z" | |
78 | - }, | |
79 | - "assignee":{ | |
80 | - "id":1, | |
81 | - "username": "admin", | |
82 | - "email":"admin@local.host", | |
83 | - "name":"Administrator", | |
84 | - "state":"active", | |
85 | - "created_at":"2012-04-29T08:46:00Z" | |
86 | - } | |
62 | + "id": 1, | |
63 | + "iid": 1, | |
64 | + "target_branch": "master", | |
65 | + "source_branch": "test1", | |
66 | + "project_id": 3, | |
67 | + "title": "test1", | |
68 | + "state": "merged", | |
69 | + "upvotes": 0, | |
70 | + "downvotes": 0, | |
71 | + "author": { | |
72 | + "id": 1, | |
73 | + "username": "admin", | |
74 | + "email": "admin@local.host", | |
75 | + "name": "Administrator", | |
76 | + "state": "active", | |
77 | + "created_at": "2012-04-29T08:46:00Z" | |
78 | + }, | |
79 | + "assignee": { | |
80 | + "id": 1, | |
81 | + "username": "admin", | |
82 | + "email": "admin@local.host", | |
83 | + "name": "Administrator", | |
84 | + "state": "active", | |
85 | + "created_at": "2012-04-29T08:46:00Z" | |
86 | + } | |
87 | 87 | } |
88 | 88 | ``` |
89 | 89 | |
... | ... | @@ -106,30 +106,30 @@ Parameters: |
106 | 106 | |
107 | 107 | ```json |
108 | 108 | { |
109 | - "id":1, | |
110 | - "target_branch":"master", | |
111 | - "source_branch":"test1", | |
112 | - "project_id":3, | |
113 | - "title":"test1", | |
114 | - "state":"opened", | |
115 | - "upvotes":0, | |
116 | - "downvotes":0, | |
117 | - "author":{ | |
118 | - "id":1, | |
119 | - "username": "admin", | |
120 | - "email":"admin@local.host", | |
121 | - "name":"Administrator", | |
122 | - "state":"active", | |
123 | - "created_at":"2012-04-29T08:46:00Z" | |
124 | - }, | |
125 | - "assignee":{ | |
126 | - "id":1, | |
127 | - "username": "admin", | |
128 | - "email":"admin@local.host", | |
129 | - "name":"Administrator", | |
130 | - "state":"active", | |
131 | - "created_at":"2012-04-29T08:46:00Z" | |
132 | - } | |
109 | + "id": 1, | |
110 | + "target_branch": "master", | |
111 | + "source_branch": "test1", | |
112 | + "project_id": 3, | |
113 | + "title": "test1", | |
114 | + "state": "opened", | |
115 | + "upvotes": 0, | |
116 | + "downvotes": 0, | |
117 | + "author": { | |
118 | + "id": 1, | |
119 | + "username": "admin", | |
120 | + "email": "admin@local.host", | |
121 | + "name": "Administrator", | |
122 | + "state": "active", | |
123 | + "created_at": "2012-04-29T08:46:00Z" | |
124 | + }, | |
125 | + "assignee": { | |
126 | + "id": 1, | |
127 | + "username": "admin", | |
128 | + "email": "admin@local.host", | |
129 | + "name": "Administrator", | |
130 | + "state": "active", | |
131 | + "created_at": "2012-04-29T08:46:00Z" | |
132 | + } | |
133 | 133 | } |
134 | 134 | ``` |
135 | 135 | |
... | ... | @@ -153,32 +153,31 @@ Parameters: |
153 | 153 | + `state_event` - New state (close|reopen|merge) |
154 | 154 | |
155 | 155 | ```json |
156 | - | |
157 | 156 | { |
158 | - "id":1, | |
159 | - "target_branch":"master", | |
160 | - "source_branch":"test1", | |
161 | - "project_id":3, | |
162 | - "title":"test1", | |
163 | - "state":"opened", | |
164 | - "upvotes":0, | |
165 | - "downvotes":0, | |
166 | - "author":{ | |
167 | - "id":1, | |
168 | - "username": "admin", | |
169 | - "email":"admin@local.host", | |
170 | - "name":"Administrator", | |
171 | - "state":"active", | |
172 | - "created_at":"2012-04-29T08:46:00Z" | |
173 | - }, | |
174 | - "assignee":{ | |
175 | - "id":1, | |
176 | - "username": "admin", | |
177 | - "email":"admin@local.host", | |
178 | - "name":"Administrator", | |
179 | - "state":"active", | |
180 | - "created_at":"2012-04-29T08:46:00Z" | |
181 | - } | |
157 | + "id": 1, | |
158 | + "target_branch": "master", | |
159 | + "source_branch": "test1", | |
160 | + "project_id": 3, | |
161 | + "title": "test1", | |
162 | + "state": "opened", | |
163 | + "upvotes": 0, | |
164 | + "downvotes": 0, | |
165 | + "author": { | |
166 | + "id": 1, | |
167 | + "username": "admin", | |
168 | + "email": "admin@local.host", | |
169 | + "name": "Administrator", | |
170 | + "state": "active", | |
171 | + "created_at": "2012-04-29T08:46:00Z" | |
172 | + }, | |
173 | + "assignee": { | |
174 | + "id": 1, | |
175 | + "username": "admin", | |
176 | + "email": "admin@local.host", | |
177 | + "name": "Administrator", | |
178 | + "state": "active", | |
179 | + "created_at": "2012-04-29T08:46:00Z" | |
180 | + } | |
182 | 181 | } |
183 | 182 | ``` |
184 | 183 | |
... | ... | @@ -200,15 +199,15 @@ Parameters: |
200 | 199 | |
201 | 200 | ```json |
202 | 201 | { |
203 | - "author":{ | |
204 | - "id":1, | |
205 | - "username": "admin", | |
206 | - "email":"admin@local.host", | |
207 | - "name":"Administrator", | |
208 | - "blocked":false, | |
209 | - "created_at":"2012-04-29T08:46:00Z" | |
210 | - }, | |
211 | - "note":"text1" | |
202 | + "author": { | |
203 | + "id": 1, | |
204 | + "username": "admin", | |
205 | + "email": "admin@local.host", | |
206 | + "name": "Administrator", | |
207 | + "blocked": false, | |
208 | + "created_at": "2012-04-29T08:46:00Z" | |
209 | + }, | |
210 | + "note": "text1" | |
212 | 211 | } |
213 | 212 | ``` |
214 | 213 | |
... | ... | @@ -228,27 +227,27 @@ Parameters: |
228 | 227 | |
229 | 228 | ```json |
230 | 229 | [ |
231 | - { | |
232 | - "note":"this is the 1st comment on the 2merge merge request", | |
233 | - "author":{ | |
234 | - "id":11, | |
235 | - "username":"admin", | |
236 | - "email":"admin@local.host", | |
237 | - "name":"Administrator", | |
238 | - "state":"active", | |
239 | - "created_at":"2014-03-06T08:17:35.000Z" | |
240 | - } | |
241 | - }, | |
242 | - { | |
243 | - "note":"_Status changed to closed_", | |
244 | - "author":{ | |
245 | - "id":11, | |
246 | - "username":"admin", | |
247 | - "email":"admin@local.host", | |
248 | - "name":"Administrator", | |
249 | - "state":"active", | |
250 | - "created_at":"2014-03-06T08:17:35.000Z" | |
251 | - } | |
230 | + { | |
231 | + "note": "this is the 1st comment on the 2merge merge request", | |
232 | + "author": { | |
233 | + "id": 11, | |
234 | + "username": "admin", | |
235 | + "email": "admin@local.host", | |
236 | + "name": "Administrator", | |
237 | + "state": "active", | |
238 | + "created_at": "2014-03-06T08:17:35.000Z" | |
239 | + } | |
240 | + }, | |
241 | + { | |
242 | + "note": "_Status changed to closed_", | |
243 | + "author": { | |
244 | + "id": 11, | |
245 | + "username": "admin", | |
246 | + "email": "admin@local.host", | |
247 | + "name": "Administrator", | |
248 | + "state": "active", | |
249 | + "created_at": "2014-03-06T08:17:35.000Z" | |
252 | 250 | } |
251 | + } | |
253 | 252 | ] |
254 | 253 | ``` | ... | ... |
doc/api/milestones.md
... | ... | @@ -9,15 +9,15 @@ GET /projects/:id/milestones |
9 | 9 | ```json |
10 | 10 | [ |
11 | 11 | { |
12 | - "id":12, | |
13 | - "iid":3, | |
14 | - "project_id":16, | |
15 | - "title":"10.0", | |
16 | - "description":"Version", | |
17 | - "due_date":"2013-11-29", | |
18 | - "state":"active", | |
19 | - "updated_at":"2013-10-02T09:24:18Z", | |
20 | - "created_at":"2013-10-02T09:24:18Z" | |
12 | + "id": 12, | |
13 | + "iid": 3, | |
14 | + "project_id": 16, | |
15 | + "title": "10.0", | |
16 | + "description": "Version", | |
17 | + "due_date": "2013-11-29", | |
18 | + "state": "active", | |
19 | + "updated_at": "2013-10-02T09:24:18Z", | |
20 | + "created_at": "2013-10-02T09:24:18Z" | |
21 | 21 | } |
22 | 22 | ] |
23 | 23 | ``` | ... | ... |
doc/api/notes.md
... | ... | @@ -17,7 +17,7 @@ Parameters: |
17 | 17 | { |
18 | 18 | "id": 522, |
19 | 19 | "body": "The solution is rather tricky", |
20 | - "attachment":null, | |
20 | + "attachment": null, | |
21 | 21 | "author": { |
22 | 22 | "id": 1, |
23 | 23 | "username": "john_smith", |
... | ... | @@ -77,32 +77,32 @@ Parameters: |
77 | 77 | ```json |
78 | 78 | [ |
79 | 79 | { |
80 | - "id":302, | |
81 | - "body":"_Status changed to closed_", | |
82 | - "attachment":null, | |
83 | - "author":{ | |
84 | - "id":1, | |
85 | - "username":"pipin", | |
86 | - "email":"admin@example.com", | |
87 | - "name":"Pip", | |
88 | - "state":"active", | |
89 | - "created_at":"2013-09-30T13:46:01Z" | |
80 | + "id": 302, | |
81 | + "body": "_Status changed to closed_", | |
82 | + "attachment": null, | |
83 | + "author": { | |
84 | + "id": 1, | |
85 | + "username": "pipin", | |
86 | + "email": "admin@example.com", | |
87 | + "name": "Pip", | |
88 | + "state": "active", | |
89 | + "created_at": "2013-09-30T13:46:01Z" | |
90 | 90 | }, |
91 | - "created_at":"2013-10-02T09:22:45Z" | |
91 | + "created_at": "2013-10-02T09:22:45Z" | |
92 | 92 | }, |
93 | 93 | { |
94 | - "id":305, | |
95 | - "body":"Text of the comment\r\n", | |
96 | - "attachment":null, | |
97 | - "author":{ | |
98 | - "id":1, | |
99 | - "username":"pipin", | |
100 | - "email":"admin@example.com", | |
101 | - "name":"Pip", | |
102 | - "state":"active", | |
103 | - "created_at":"2013-09-30T13:46:01Z" | |
94 | + "id": 305, | |
95 | + "body": "Text of the comment\r\n", | |
96 | + "attachment": null, | |
97 | + "author": { | |
98 | + "id": 1, | |
99 | + "username": "pipin", | |
100 | + "email": "admin@example.com", | |
101 | + "name": "Pip", | |
102 | + "state": "active", | |
103 | + "created_at": "2013-09-30T13:46:01Z" | |
104 | 104 | }, |
105 | - "created_at":"2013-10-02T09:56:03Z" | |
105 | + "created_at": "2013-10-02T09:56:03Z" | |
106 | 106 | } |
107 | 107 | ] |
108 | 108 | ``` |
... | ... | @@ -169,20 +169,20 @@ Parameters: |
169 | 169 | |
170 | 170 | ```json |
171 | 171 | { |
172 | - "id":52, | |
173 | - "title":"Snippet", | |
174 | - "file_name":"snippet.rb", | |
175 | - "author":{ | |
176 | - "id":1, | |
177 | - "username":"pipin", | |
178 | - "email":"admin@example.com", | |
179 | - "name":"Pip", | |
180 | - "state":"active", | |
181 | - "created_at":"2013-09-30T13:46:01Z" | |
172 | + "id": 52, | |
173 | + "title": "Snippet", | |
174 | + "file_name": "snippet.rb", | |
175 | + "author": { | |
176 | + "id": 1, | |
177 | + "username": "pipin", | |
178 | + "email": "admin@example.com", | |
179 | + "name": "Pip", | |
180 | + "state": "active", | |
181 | + "created_at": "2013-09-30T13:46:01Z" | |
182 | 182 | }, |
183 | - "expires_at":null, | |
184 | - "updated_at":"2013-10-02T07:34:20Z", | |
185 | - "created_at":"2013-10-02T07:34:20Z" | |
183 | + "expires_at": null, | |
184 | + "updated_at": "2013-10-02T07:34:20Z", | |
185 | + "created_at": "2013-10-02T07:34:20Z" | |
186 | 186 | } |
187 | 187 | ``` |
188 | 188 | |
... | ... | @@ -233,18 +233,18 @@ Parameters: |
233 | 233 | |
234 | 234 | ```json |
235 | 235 | { |
236 | - "id":301, | |
237 | - "body":"Comment for MR", | |
238 | - "attachment":null, | |
239 | - "author":{ | |
240 | - "id":1, | |
241 | - "username":"pipin", | |
242 | - "email":"admin@example.com", | |
243 | - "name":"Pip", | |
244 | - "state":"active", | |
245 | - "created_at":"2013-09-30T13:46:01Z" | |
236 | + "id": 301, | |
237 | + "body": "Comment for MR", | |
238 | + "attachment": null, | |
239 | + "author": { | |
240 | + "id": 1, | |
241 | + "username": "pipin", | |
242 | + "email": "admin@example.com", | |
243 | + "name": "Pip", | |
244 | + "state": "active", | |
245 | + "created_at": "2013-09-30T13:46:01Z" | |
246 | 246 | }, |
247 | - "created_at":"2013-10-02T08:57:14Z" | |
247 | + "created_at": "2013-10-02T08:57:14Z" | |
248 | 248 | } |
249 | 249 | ``` |
250 | 250 | ... | ... |
doc/api/projects.md
... | ... | @@ -54,7 +54,7 @@ GET /projects |
54 | 54 | "ssh_url_to_repo": "git@example.com:brightbox/puppet.git", |
55 | 55 | "http_url_to_repo": "http://example.com/brightbox/puppet.git", |
56 | 56 | "web_url": "http://example.com/brightbox/puppet", |
57 | - "owner": { | |
57 | + "owner": { | |
58 | 58 | "id": 4, |
59 | 59 | "name": "Brightbox", |
60 | 60 | "created_at": "2013-09-30T13:46:02Z" |
... | ... | @@ -70,7 +70,7 @@ GET /projects |
70 | 70 | "snippets_enabled": false, |
71 | 71 | "created_at": "2013-09-30T13:46:02Z", |
72 | 72 | "last_activity_at": "2013-09-30T13:46:02Z", |
73 | - "namespace": { | |
73 | + "namespace": { | |
74 | 74 | "created_at": "2013-09-30T13:46:02Z", |
75 | 75 | "description": "", |
76 | 76 | "id": 4, |
... | ... | @@ -147,7 +147,7 @@ Parameters: |
147 | 147 | "owner_id": 1, |
148 | 148 | "path": "diaspora", |
149 | 149 | "updated_at": "2013-09-30T13: 46: 02Z" |
150 | - } | |
150 | + }, | |
151 | 151 | "permissions": { |
152 | 152 | "project_access": { |
153 | 153 | "access_level": 10, |
... | ... | @@ -175,58 +175,63 @@ Parameters: |
175 | 175 | + `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project |
176 | 176 | |
177 | 177 | ```json |
178 | - | |
179 | -[{ | |
180 | - "title": null, | |
181 | - "project_id": 15, | |
182 | - "action_name": "closed", | |
183 | - "target_id": 830, | |
184 | - "target_type": "Issue", | |
185 | - "author_id": 1, | |
186 | - "data": null, | |
187 | - "target_title": "Public project search field" | |
188 | -}, { | |
189 | - "title": null, | |
190 | - "project_id": 15, | |
191 | - "action_name": "opened", | |
192 | - "target_id": null, | |
193 | - "target_type": null, | |
194 | - "author_id": 1, | |
195 | - "data": { | |
196 | - "before": "50d4420237a9de7be1304607147aec22e4a14af7", | |
197 | - "after": "c5feabde2d8cd023215af4d2ceeb7a64839fc428", | |
198 | - "ref": "refs/heads/master", | |
199 | - "user_id": 1, | |
200 | - "user_name": "Dmitriy Zaporozhets", | |
201 | - "repository": { | |
202 | - "name": "gitlabhq", | |
203 | - "url": "git@dev.gitlab.org:gitlab/gitlabhq.git", | |
204 | - "description": "GitLab: self hosted Git management software. \r\nDistributed under the MIT License.", | |
205 | - "homepage": "https://dev.gitlab.org/gitlab/gitlabhq" | |
178 | +[ | |
179 | + { | |
180 | + "title": null, | |
181 | + "project_id": 15, | |
182 | + "action_name": "closed", | |
183 | + "target_id": 830, | |
184 | + "target_type": "Issue", | |
185 | + "author_id": 1, | |
186 | + "data": null, | |
187 | + "target_title": "Public project search field" | |
188 | + }, | |
189 | + { | |
190 | + "title": null, | |
191 | + "project_id": 15, | |
192 | + "action_name": "opened", | |
193 | + "target_id": null, | |
194 | + "target_type": null, | |
195 | + "author_id": 1, | |
196 | + "data": { | |
197 | + "before": "50d4420237a9de7be1304607147aec22e4a14af7", | |
198 | + "after": "c5feabde2d8cd023215af4d2ceeb7a64839fc428", | |
199 | + "ref": "refs/heads/master", | |
200 | + "user_id": 1, | |
201 | + "user_name": "Dmitriy Zaporozhets", | |
202 | + "repository": { | |
203 | + "name": "gitlabhq", | |
204 | + "url": "git@dev.gitlab.org:gitlab/gitlabhq.git", | |
205 | + "description": "GitLab: self hosted Git management software. \r\nDistributed under the MIT License.", | |
206 | + "homepage": "https://dev.gitlab.org/gitlab/gitlabhq" | |
207 | + }, | |
208 | + "commits": [ | |
209 | + { | |
210 | + "id": "c5feabde2d8cd023215af4d2ceeb7a64839fc428", | |
211 | + "message": "Add simple search to projects in public area", | |
212 | + "timestamp": "2013-05-13T18:18:08+00:00", | |
213 | + "url": "https://dev.gitlab.org/gitlab/gitlabhq/commit/c5feabde2d8cd023215af4d2ceeb7a64839fc428", | |
214 | + "author": { | |
215 | + "name": "Dmitriy Zaporozhets", | |
216 | + "email": "dmitriy.zaporozhets@gmail.com" | |
217 | + } | |
218 | + } | |
219 | + ], | |
220 | + "total_commits_count": 1 | |
206 | 221 | }, |
207 | - "commits": [{ | |
208 | - "id": "c5feabde2d8cd023215af4d2ceeb7a64839fc428", | |
209 | - "message": "Add simple search to projects in public area", | |
210 | - "timestamp": "2013-05-13T18:18:08+00:00", | |
211 | - "url": "https://dev.gitlab.org/gitlab/gitlabhq/commit/c5feabde2d8cd023215af4d2ceeb7a64839fc428", | |
212 | - "author": { | |
213 | - "name": "Dmitriy Zaporozhets", | |
214 | - "email": "dmitriy.zaporozhets@gmail.com" | |
215 | - } | |
216 | - }], | |
217 | - "total_commits_count": 1 | |
222 | + "target_title": null | |
218 | 223 | }, |
219 | - "target_title": null | |
220 | -}, { | |
221 | - "title": null, | |
222 | - "project_id": 15, | |
223 | - "action_name": "closed", | |
224 | - "target_id": 840, | |
225 | - "target_type": "Issue", | |
226 | - "author_id": 1, | |
227 | - "data": null, | |
228 | - "target_title": "Finish & merge Code search PR" | |
229 | -}] | |
224 | + { | |
225 | + "title": null, | |
226 | + "project_id": 15, | |
227 | + "action_name": "closed", | |
228 | + "target_id": 840, | |
229 | + "target_type": "Issue", | |
230 | + "author_id": 1, | |
231 | + "data": null, | |
232 | + "target_title": "Finish & merge Code search PR" | |
233 | + } | |
234 | +] | |
230 | 235 | ``` |
231 | 236 | |
232 | 237 | |
... | ... | @@ -493,34 +498,38 @@ Parameters: |
493 | 498 | ```json |
494 | 499 | [ |
495 | 500 | { |
496 | - "name":"async", | |
501 | + "name": "async", | |
497 | 502 | "commit": { |
498 | - "id":"a2b702edecdf41f07b42653eb1abe30ce98b9fca", | |
499 | - "parents": [{ | |
500 | - "id":"3f94fc7c85061973edc9906ae170cc269b07ca55" | |
501 | - }], | |
503 | + "id": "a2b702edecdf41f07b42653eb1abe30ce98b9fca", | |
504 | + "parents": [ | |
505 | + { | |
506 | + "id": "3f94fc7c85061973edc9906ae170cc269b07ca55" | |
507 | + } | |
508 | + ], | |
502 | 509 | "tree": "c68537c6534a02cc2b176ca1549f4ffa190b58ee", |
503 | - "message":"give caolan credit where it's due (up top)", | |
510 | + "message": "give caolan credit where it's due (up top)", | |
504 | 511 | "author": { |
505 | - "name":"Jeremy Ashkenas", | |
506 | - "email":"jashkenas@example.com" | |
512 | + "name": "Jeremy Ashkenas", | |
513 | + "email": "jashkenas@example.com" | |
507 | 514 | }, |
508 | 515 | "committer": { |
509 | - "name":"Jeremy Ashkenas", | |
510 | - "email":"jashkenas@example.com" | |
516 | + "name": "Jeremy Ashkenas", | |
517 | + "email": "jashkenas@example.com" | |
511 | 518 | }, |
512 | - "authored_date":"2010-12-08T21:28:50+00:00", | |
513 | - "committed_date":"2010-12-08T21:28:50+00:00" | |
519 | + "authored_date": "2010-12-08T21:28:50+00:00", | |
520 | + "committed_date": "2010-12-08T21:28:50+00:00" | |
514 | 521 | }, |
515 | - "protected":false | |
522 | + "protected": false | |
516 | 523 | }, |
517 | 524 | { |
518 | 525 | "name": "gh-pages", |
519 | 526 | "commit": { |
520 | 527 | "id": "101c10a60019fe870d21868835f65c25d64968fc", |
521 | - "parents": [{ | |
522 | - "id": "9c15d2e26945a665131af5d7b6d30a06ba338aaa" | |
523 | - }], | |
528 | + "parents": [ | |
529 | + { | |
530 | + "id": "9c15d2e26945a665131af5d7b6d30a06ba338aaa" | |
531 | + } | |
532 | + ], | |
524 | 533 | "tree": "fb5cc9d45da3014b17a876ad539976a0fb9b352a", |
525 | 534 | "message": "Underscore.js 1.5.2", |
526 | 535 | "author": { |
... | ... | @@ -537,7 +546,6 @@ Parameters: |
537 | 546 | "protected": false |
538 | 547 | } |
539 | 548 | ] |
540 | - | |
541 | 549 | ``` |
542 | 550 | |
543 | 551 | ### List single branch |
... | ... | @@ -640,7 +648,7 @@ Parameters: |
640 | 648 | ```json |
641 | 649 | [ |
642 | 650 | { |
643 | - "name":"featute" | |
651 | + "name": "feature" | |
644 | 652 | }, |
645 | 653 | { |
646 | 654 | "name": "bug" | ... | ... |
doc/api/repositories.md
... | ... | @@ -16,9 +16,7 @@ Parameters: |
16 | 16 | "name": "v1.0.0", |
17 | 17 | "commit": { |
18 | 18 | "id": "2695effb5807a22ff3d138d593fd856244e155e7", |
19 | - "parents": [ | |
20 | - | |
21 | - ], | |
19 | + "parents": [], | |
22 | 20 | "tree": "38017f2f189336fe4497e9d230c5bb1bf873f08d", |
23 | 21 | "message": "Initial commit", |
24 | 22 | "author": { |
... | ... | @@ -52,39 +50,44 @@ Parameters: |
52 | 50 | + `ref_name` (optional) - The name of a repository branch or tag or if not given the default branch |
53 | 51 | |
54 | 52 | ```json |
55 | - | |
56 | -[{ | |
57 | - "name": "assets", | |
58 | - "type": "tree", | |
59 | - "mode": "040000", | |
60 | - "id": "6229c43a7e16fcc7e95f923f8ddadb8281d9c6c6" | |
61 | -}, { | |
62 | - "name": "contexts", | |
63 | - "type": "tree", | |
64 | - "mode": "040000", | |
65 | - "id": "faf1cdf33feadc7973118ca42d35f1e62977e91f" | |
66 | -}, { | |
67 | - "name": "controllers", | |
68 | - "type": "tree", | |
69 | - "mode": "040000", | |
70 | - "id": "95633e8d258bf3dfba3a5268fb8440d263218d74" | |
71 | -}, { | |
72 | - "name": "Rakefile", | |
73 | - "type": "blob", | |
74 | - "mode": "100644", | |
75 | - "id": "35b2f05cbb4566b71b34554cf184a9d0bd9d46d6" | |
76 | -}, { | |
77 | - "name": "VERSION", | |
78 | - "type": "blob", | |
79 | - "mode": "100644", | |
80 | - "id": "803e4a4f3727286c3093c63870c2b6524d30ec4f" | |
81 | -}, { | |
82 | - "name": "config.ru", | |
83 | - "type": "blob", | |
84 | - "mode": "100644", | |
85 | - "id": "dfd2d862237323aa599be31b473d70a8a817943b" | |
86 | -}] | |
87 | - | |
53 | +[ | |
54 | + { | |
55 | + "name": "assets", | |
56 | + "type": "tree", | |
57 | + "mode": "040000", | |
58 | + "id": "6229c43a7e16fcc7e95f923f8ddadb8281d9c6c6" | |
59 | + }, | |
60 | + { | |
61 | + "name": "contexts", | |
62 | + "type": "tree", | |
63 | + "mode": "040000", | |
64 | + "id": "faf1cdf33feadc7973118ca42d35f1e62977e91f" | |
65 | + }, | |
66 | + { | |
67 | + "name": "controllers", | |
68 | + "type": "tree", | |
69 | + "mode": "040000", | |
70 | + "id": "95633e8d258bf3dfba3a5268fb8440d263218d74" | |
71 | + }, | |
72 | + { | |
73 | + "name": "Rakefile", | |
74 | + "type": "blob", | |
75 | + "mode": "100644", | |
76 | + "id": "35b2f05cbb4566b71b34554cf184a9d0bd9d46d6" | |
77 | + }, | |
78 | + { | |
79 | + "name": "VERSION", | |
80 | + "type": "blob", | |
81 | + "mode": "100644", | |
82 | + "id": "803e4a4f3727286c3093c63870c2b6524d30ec4f" | |
83 | + }, | |
84 | + { | |
85 | + "name": "config.ru", | |
86 | + "type": "blob", | |
87 | + "mode": "100644", | |
88 | + "id": "dfd2d862237323aa599be31b473d70a8a817943b" | |
89 | + } | |
90 | +] | |
88 | 91 | ``` |
89 | 92 | |
90 | 93 | ... | ... |
doc/api/repository_files.md
... | ... | @@ -44,7 +44,7 @@ Example response: |
44 | 44 | ```json |
45 | 45 | { |
46 | 46 | "file_name": "app/project.rb", |
47 | - "branch_name": "master", | |
47 | + "branch_name": "master" | |
48 | 48 | } |
49 | 49 | ``` |
50 | 50 | |
... | ... | @@ -67,7 +67,7 @@ Example response: |
67 | 67 | ```json |
68 | 68 | { |
69 | 69 | "file_name": "app/project.rb", |
70 | - "branch_name": "master", | |
70 | + "branch_name": "master" | |
71 | 71 | } |
72 | 72 | ``` |
73 | 73 | |
... | ... | @@ -90,7 +90,7 @@ Example response: |
90 | 90 | ```json |
91 | 91 | { |
92 | 92 | "file_name": "app/project.rb", |
93 | - "branch_name": "master", | |
93 | + "branch_name": "master" | |
94 | 94 | } |
95 | 95 | ``` |
96 | 96 | ... | ... |
doc/api/session.md
... | ... | @@ -30,8 +30,8 @@ __You can login with both GitLab and LDAP credentials now__ |
30 | 30 | "dark_scheme": false, |
31 | 31 | "theme_id": 1, |
32 | 32 | "is_admin": false, |
33 | - "can_create_group" : true, | |
34 | - "can_create_team" : true, | |
35 | - "can_create_project" : true | |
33 | + "can_create_group": true, | |
34 | + "can_create_team": true, | |
35 | + "can_create_project": true | |
36 | 36 | } |
37 | 37 | ``` | ... | ... |
doc/api/system_hooks.md
... | ... | @@ -17,9 +17,9 @@ Parameters: |
17 | 17 | ```json |
18 | 18 | [ |
19 | 19 | { |
20 | - "id":3, | |
21 | - "url":"http://example.com/hook", | |
22 | - "created_at":"2013-10-02T10:15:31Z" | |
20 | + "id": 3, | |
21 | + "url": "http://example.com/hook", | |
22 | + "created_at": "2013-10-02T10:15:31Z" | |
23 | 23 | } |
24 | 24 | ] |
25 | 25 | ``` |
... | ... | @@ -47,12 +47,12 @@ Parameters: |
47 | 47 | |
48 | 48 | ```json |
49 | 49 | { |
50 | - "event_name":"project_create", | |
51 | - "name":"Ruby", | |
52 | - "path":"ruby", | |
53 | - "project_id":1, | |
54 | - "owner_name":"Someone", | |
55 | - "owner_email":"example@gitlabhq.com" | |
50 | + "event_name": "project_create", | |
51 | + "name": "Ruby", | |
52 | + "path": "ruby", | |
53 | + "project_id": 1, | |
54 | + "owner_name": "Someone", | |
55 | + "owner_email": "example@gitlabhq.com" | |
56 | 56 | } |
57 | 57 | ``` |
58 | 58 | ... | ... |
doc/api/users.md
... | ... | @@ -187,8 +187,8 @@ GET /user |
187 | 187 | "theme_id": 1, |
188 | 188 | "color_scheme_id": 2, |
189 | 189 | "is_admin": false, |
190 | - "can_create_group" : true, | |
191 | - "can_create_project" : true | |
190 | + "can_create_group": true, | |
191 | + "can_create_project": true | |
192 | 192 | } |
193 | 193 | ``` |
194 | 194 | |
... | ... | @@ -205,17 +205,13 @@ GET /user/keys |
205 | 205 | [ |
206 | 206 | { |
207 | 207 | "id": 1, |
208 | - "title" : "Public key", | |
209 | - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4 | |
210 | - 596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4 | |
211 | - soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=", | |
208 | + "title": "Public key", | |
209 | + "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=" | |
212 | 210 | }, |
213 | 211 | { |
214 | 212 | "id": 3, |
215 | - "title" : "Another Public key", | |
216 | - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4 | |
217 | - 596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4 | |
218 | - soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=" | |
213 | + "title": "Another Public key", | |
214 | + "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=" | |
219 | 215 | } |
220 | 216 | ] |
221 | 217 | ``` |
... | ... | @@ -240,10 +236,8 @@ Parameters: |
240 | 236 | ```json |
241 | 237 | { |
242 | 238 | "id": 1, |
243 | - "title" : "Public key", | |
244 | - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4 | |
245 | - 596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4 | |
246 | - soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=" | |
239 | + "title": "Public key", | |
240 | + "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=" | |
247 | 241 | } |
248 | 242 | ``` |
249 | 243 | ... | ... |