Download as
Browse Code »

Commit 949b1df930bedace1dbd755aaa4a82e8c451a616

Authored by Nihad Abbasov
1 parent 1b95c8bf
Exists in master and in 4 other branches 6-8-stable, 7-0-stable, 7-0-stable-spb, spb-stable

API: update docs

Showing 4 changed files with 29 additions and 29 deletions   Show diff stats
doc/api/issues.md
  Diff comments   View file @949b1df
... ... @@ -73,7 +73,7 @@ GET /projects/:id/issues
73 73  
74 74 Parameters:
75 75  
76   -+ `id` (required) - The code name of a project
  76 ++ `id` (required) - The ID or code name of a project
77 77  
78 78 ## Single issue
79 79  
... ... @@ -85,7 +85,7 @@ GET /projects/:id/issues/:issue_id
85 85  
86 86 Parameters:
87 87  
88   -+ `id` (required) - The code name of a project
  88 ++ `id` (required) - The ID or code name of a project
89 89 + `issue_id` (required) - The ID of a project issue
90 90  
91 91 ```json
... ... @@ -135,7 +135,7 @@ POST /projects/:id/issues
135 135  
136 136 Parameters:
137 137  
138   -+ `id` (required) - The code name of a project
  138 ++ `id` (required) - The ID or code name of a project
139 139 + `title` (required) - The title of an issue
140 140 + `description` (optional) - The description of an issue
141 141 + `assignee_id` (optional) - The ID of a user to assign issue
... ... @@ -154,7 +154,7 @@ PUT /projects/:id/issues/:issue_id
154 154  
155 155 Parameters:
156 156  
157   -+ `id` (required) - The code name of a project
  157 ++ `id` (required) - The ID or code name of a project
158 158 + `issue_id` (required) - The ID of a project's issue
159 159 + `title` (optional) - The title of an issue
160 160 + `description` (optional) - The description of an issue
... ... @@ -175,7 +175,7 @@ DELETE /projects/:id/issues/:issue_id
175 175  
176 176 Parameters:
177 177  
178   -+ `id` (required) - The code name of a project
  178 ++ `id` (required) - The ID or code name of a project
179 179 + `issue_id` (required) - The ID of a project's issue
180 180  
181 181 Status code `200` will be returned on success.
... ...
doc/api/projects.md
  Diff comments   View file @949b1df
1 1 ## List projects
2 2  
3   -Get a list of authenticated users' projects.
  3 +Get a list of authenticated user's projects.
4 4  
5 5 ```
6 6 GET /projects
... ... @@ -63,7 +63,7 @@ GET /projects/:id
63 63  
64 64 Parameters:
65 65  
66   -+ `id` (required) - The code name of a project
  66 ++ `id` (required) - The ID or code name of a project
67 67  
68 68 ```json
69 69 {
... ... @@ -91,7 +91,7 @@ Parameters:
91 91  
92 92 ## Project repository branches
93 93  
94   -Get a list of project repository branches.
  94 +Get a list of project repository branches sorted by name alphabetically.
95 95  
96 96 ```
97 97 GET /projects/:id/repository/branches
... ... @@ -99,7 +99,7 @@ GET /projects/:id/repository/branches
99 99  
100 100 Parameters:
101 101  
102   -+ `id` (required) - The code name of a project
  102 ++ `id` (required) - The ID or code name of a project
103 103  
104 104 ```json
105 105 [
... ... @@ -131,7 +131,7 @@ Parameters:
131 131  
132 132 ## Project repository tags
133 133  
134   -Get a list of project repository tags.
  134 +Get a list of project repository tags sorted by name in reverse alphabetical order.
135 135  
136 136 ```
137 137 GET /projects/:id/repository/tags
... ... @@ -139,7 +139,7 @@ GET /projects/:id/repository/tags
139 139  
140 140 Parameters:
141 141  
142   -+ `id` (required) - The code name of a project
  142 ++ `id` (required) - The ID or code name of a project
143 143  
144 144 ```json
145 145 [
... ... @@ -183,7 +183,7 @@ GET /projects/:id/snippets/:snippet_id
183 183  
184 184 Parameters:
185 185  
186   -+ `id` (required) - The code name of a project
  186 ++ `id` (required) - The ID or code name of a project
187 187 + `snippet_id` (required) - The ID of a project's snippet
188 188  
189 189 ```json
... ... @@ -214,7 +214,7 @@ GET /projects/:id/snippets/:snippet_id/raw
214 214  
215 215 Parameters:
216 216  
217   -+ `id` (required) - The code name of a project
  217 ++ `id` (required) - The ID or code name of a project
218 218 + `snippet_id` (required) - The ID of a project's snippet
219 219  
220 220 ## New snippet
... ... @@ -227,7 +227,7 @@ POST /projects/:id/snippets
227 227  
228 228 Parameters:
229 229  
230   -+ `id` (required) - The code name of a project
  230 ++ `id` (required) - The ID or code name of a project
231 231 + `title` (required) - The title of a snippet
232 232 + `file_name` (required) - The name of a snippet file
233 233 + `lifetime` (optional) - The expiration date of a snippet
... ... @@ -245,7 +245,7 @@ PUT /projects/:id/snippets/:snippet_id
245 245  
246 246 Parameters:
247 247  
248   -+ `id` (required) - The code name of a project
  248 ++ `id` (required) - The ID or code name of a project
249 249 + `snippet_id` (required) - The ID of a project's snippet
250 250 + `title` (optional) - The title of a snippet
251 251 + `file_name` (optional) - The name of a snippet file
... ... @@ -264,7 +264,7 @@ DELETE /projects/:id/snippets/:snippet_id
264 264  
265 265 Parameters:
266 266  
267   -+ `id` (required) - The code name of a project
  267 ++ `id` (required) - The ID or code name of a project
268 268 + `snippet_id` (required) - The ID of a project's snippet
269 269  
270 270 Status code `200` will be returned on success.
... ...
lib/api/issues.rb
  Diff comments   View file @949b1df
... ... @@ -17,7 +17,7 @@ module Gitlab
17 17 # Get a list of project issues
18 18 #
19 19 # Parameters:
20   - # id (required) - The code name of a project
  20 + # id (required) - The ID or code name of a project
21 21 # Example Request:
22 22 # GET /projects/:id/issues
23 23 get ":id/issues" do
... ... @@ -27,7 +27,7 @@ module Gitlab
27 27 # Get a single project issue
28 28 #
29 29 # Parameters:
30   - # id (required) - The code name of a project
  30 + # id (required) - The ID or code name of a project
31 31 # issue_id (required) - The ID of a project issue
32 32 # Example Request:
33 33 # GET /projects/:id/issues/:issue_id
... ... @@ -39,7 +39,7 @@ module Gitlab
39 39 # Create a new project issue
40 40 #
41 41 # Parameters:
42   - # id (required) - The code name of a project
  42 + # id (required) - The ID or code name of a project
43 43 # title (required) - The title of an issue
44 44 # description (optional) - The description of an issue
45 45 # assignee_id (optional) - The ID of a user to assign issue
... ... @@ -67,7 +67,7 @@ module Gitlab
67 67 # Update an existing issue
68 68 #
69 69 # Parameters:
70   - # id (required) - The code name of a project
  70 + # id (required) - The ID or code name of a project
71 71 # issue_id (required) - The ID of a project issue
72 72 # title (optional) - The title of an issue
73 73 # description (optional) - The description of an issue
... ... @@ -98,7 +98,7 @@ module Gitlab
98 98 # Delete a project issue
99 99 #
100 100 # Parameters:
101   - # id (required) - The code name of a project
  101 + # id (required) - The ID or code name of a project
102 102 # issue_id (required) - The ID of a project issue
103 103 # Example Request:
104 104 # DELETE /projects/:id/issues/:issue_id
... ...
lib/api/projects.rb
  Diff comments   View file @949b1df
... ... @@ -16,7 +16,7 @@ module Gitlab
16 16 # Get a single project
17 17 #
18 18 # Parameters:
19   - # id (required) - The code of a project
  19 + # id (required) - The ID or code name of a project
20 20 # Example Request:
21 21 # GET /projects/:id
22 22 get ":id" do
... ... @@ -26,7 +26,7 @@ module Gitlab
26 26 # Get a project repository branches
27 27 #
28 28 # Parameters:
29   - # id (required) - The code of a project
  29 + # id (required) - The ID or code name of a project
30 30 # Example Request:
31 31 # GET /projects/:id/repository/branches
32 32 get ":id/repository/branches" do
... ... @@ -36,7 +36,7 @@ module Gitlab
36 36 # Get a project repository tags
37 37 #
38 38 # Parameters:
39   - # id (required) - The code of a project
  39 + # id (required) - The ID or code name of a project
40 40 # Example Request:
41 41 # GET /projects/:id/repository/tags
42 42 get ":id/repository/tags" do
... ... @@ -46,7 +46,7 @@ module Gitlab
46 46 # Get a project snippet
47 47 #
48 48 # Parameters:
49   - # id (required) - The code of a project
  49 + # id (required) - The ID or code name of a project
50 50 # snippet_id (required) - The ID of a project snippet
51 51 # Example Request:
52 52 # GET /projects/:id/snippets/:snippet_id
... ... @@ -58,7 +58,7 @@ module Gitlab
58 58 # Create a new project snippet
59 59 #
60 60 # Parameters:
61   - # id (required) - The code name of a project
  61 + # id (required) - The ID or code name of a project
62 62 # title (required) - The title of a snippet
63 63 # file_name (required) - The name of a snippet file
64 64 # lifetime (optional) - The expiration date of a snippet
... ... @@ -84,7 +84,7 @@ module Gitlab
84 84 # Update an existing project snippet
85 85 #
86 86 # Parameters:
87   - # id (required) - The code name of a project
  87 + # id (required) - The ID or code name of a project
88 88 # snippet_id (required) - The ID of a project snippet
89 89 # title (optional) - The title of a snippet
90 90 # file_name (optional) - The name of a snippet file
... ... @@ -111,7 +111,7 @@ module Gitlab
111 111 # Delete a project snippet
112 112 #
113 113 # Parameters:
114   - # id (required) - The code of a project
  114 + # id (required) - The ID or code name of a project
115 115 # snippet_id (required) - The ID of a project snippet
116 116 # Example Request:
117 117 # DELETE /projects/:id/snippets/:snippet_id
... ... @@ -123,7 +123,7 @@ module Gitlab
123 123 # Get a raw project snippet
124 124 #
125 125 # Parameters:
126   - # id (required) - The code of a project
  126 + # id (required) - The ID or code name of a project
127 127 # snippet_id (required) - The ID of a project snippet
128 128 # Example Request:
129 129 # GET /projects/:id/snippets/:snippet_id/raw
... ...