Download as
Browse Code »

Commit f1253fa7108e6277dcf9e71e0d52279b6f63b93b

Authored by Marin Jankovski
1 parent 5e96d070
Exists in master and in 4 other branches 6-8-stable, 7-0-stable, 7-0-stable-spb, spb-stable

Update issues, milestones, notes api docs.

Showing 3 changed files with 97 additions and 16 deletions   Show diff stats
doc/api/issues.md
  Diff comments   View file @f1253fa
... ... @@ -22,10 +22,10 @@ GET /issues
22 22 "username": "john_smith",
23 23 "email": "john@example.com",
24 24 "name": "John Smith",
25   - "blocked": false,
  25 + "state": "active",
26 26 "created_at": "2012-05-23T08:00:58Z"
27 27 },
28   - "state": 'closed',
  28 + "state": "closed",
29 29 "updated_at": "2012-07-02T17:53:12Z",
30 30 "created_at": "2012-07-02T17:53:12Z"
31 31 },
... ... @@ -42,7 +42,7 @@ GET /issues
42 42 "title": "v1.0",
43 43 "description": "",
44 44 "due_date": "2012-07-20",
45   - "state": 'reopenend',
  45 + "state": "reopenend",
46 46 "updated_at": "2012-07-04T13:42:48Z",
47 47 "created_at": "2012-07-04T13:42:48Z"
48 48 },
... ... @@ -51,7 +51,7 @@ GET /issues
51 51 "username": "jack_smith",
52 52 "email": "jack@example.com",
53 53 "name": "Jack Smith",
54   - "blocked": false,
  54 + "state": "active",
55 55 "created_at": "2012-05-23T08:01:01Z"
56 56 },
57 57 "author": {
... ... @@ -59,10 +59,10 @@ GET /issues
59 59 "username": "john_smith",
60 60 "email": "john@example.com",
61 61 "name": "John Smith",
62   - "blocked": false,
  62 + "state": "active",
63 63 "created_at": "2012-05-23T08:00:58Z"
64 64 },
65   - "state": 'opened',
  65 + "state": "opened",
66 66 "updated_at": "2012-07-12T13:43:19Z",
67 67 "created_at": "2012-06-28T12:58:06Z"
68 68 }
... ... @@ -111,7 +111,7 @@ Parameters:
111 111 "title": "v1.0",
112 112 "description": "",
113 113 "due_date": "2012-07-20",
114   - "state": 'closed',
  114 + "state": "closed",
115 115 "updated_at": "2012-07-04T13:42:48Z",
116 116 "created_at": "2012-07-04T13:42:48Z"
117 117 },
... ... @@ -120,7 +120,7 @@ Parameters:
120 120 "username": "jack_smith",
121 121 "email": "jack@example.com",
122 122 "name": "Jack Smith",
123   - "blocked": false,
  123 + "state": "active",
124 124 "created_at": "2012-05-23T08:01:01Z"
125 125 },
126 126 "author": {
... ... @@ -128,10 +128,10 @@ Parameters:
128 128 "username": "john_smith",
129 129 "email": "john@example.com",
130 130 "name": "John Smith",
131   - "blocked": false,
  131 + "state": "active",
132 132 "created_at": "2012-05-23T08:00:58Z"
133 133 },
134   - "state": 'opened',
  134 + "state": "opened",
135 135 "updated_at": "2012-07-12T13:43:19Z",
136 136 "created_at": "2012-06-28T12:58:06Z"
137 137 }
... ...
doc/api/milestones.md
  Diff comments   View file @f1253fa
... ... @@ -6,6 +6,21 @@ Returns a list of project milestones.
6 6 GET /projects/:id/milestones
7 7 ```
8 8  
  9 +```json
  10 +[
  11 + {
  12 + "id":12,
  13 + "project_id":16,
  14 + "title":"10.0",
  15 + "description":"Version",
  16 + "due_date":"2013-11-29",
  17 + "state":"active",
  18 + "updated_at":"2013-10-02T09:24:18Z",
  19 + "created_at":"2013-10-02T09:24:18Z"
  20 + }
  21 +]
  22 +```
  23 +
9 24 Parameters:
10 25  
11 26 + `id` (required) - The ID of a project
... ...
doc/api/notes.md
  Diff comments   View file @f1253fa
... ... @@ -8,17 +8,22 @@ Get a list of project wall notes.
8 8 GET /projects/:id/notes
9 9 ```
10 10  
  11 +Parameters:
  12 +
  13 ++ `id` (required) - The ID of a project
  14 +
11 15 ```json
12 16 [
13 17 {
14 18 "id": 522,
15 19 "body": "The solution is rather tricky",
  20 + "attachment":null,
16 21 "author": {
17 22 "id": 1,
18 23 "username": "john_smith",
19 24 "email": "john@example.com",
20 25 "name": "John Smith",
21   - "blocked": false,
  26 + "state": "active",
22 27 "created_at": "2012-05-23T08:00:58Z"
23 28 },
24 29 "created_at": "2012-11-27T19:16:44Z"
... ... @@ -26,11 +31,6 @@ GET /projects/:id/notes
26 31 ]
27 32 ```
28 33  
29   -Parameters:
30   -
31   -+ `id` (required) - The ID of a project
32   -
33   -
34 34 ### Get single wall note
35 35  
36 36 Returns a single wall note.
... ... @@ -74,6 +74,38 @@ Parameters:
74 74 + `id` (required) - The ID of a project
75 75 + `issue_id` (required) - The ID of an issue
76 76  
  77 +```json
  78 +[
  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"
  90 + },
  91 + "created_at":"2013-10-02T09:22:45Z"
  92 + },
  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"
  104 + },
  105 + "created_at":"2013-10-02T09:56:03Z"
  106 + }
  107 +]
  108 +```
77 109  
78 110 ### Get single issue note
79 111  
... ... @@ -135,6 +167,24 @@ Parameters:
135 167 + `snippet_id` (required) - The ID of a project snippet
136 168 + `note_id` (required) - The ID of an snippet note
137 169  
  170 +```json
  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"
  182 + },
  183 + "expires_at":null,
  184 + "updated_at":"2013-10-02T07:34:20Z",
  185 + "created_at":"2013-10-02T07:34:20Z"
  186 +}
  187 +```
138 188  
139 189 ### Create new snippet note
140 190  
... ... @@ -181,6 +231,22 @@ Parameters:
181 231 + `merge_request_id` (required) - The ID of a project merge request
182 232 + `note_id` (required) - The ID of a merge request note
183 233  
  234 +```json
  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"
  246 + },
  247 + "created_at":"2013-10-02T08:57:14Z"
  248 +}
  249 +```
184 250  
185 251 ### Create new merge request note
186 252  
... ...