Download as
Browse Code »

Commit 8f01190eb5ec0f40d6f8874a3f3c79637000a709

Authored by Riyad Preukschas
1 parent 931ec399
Exists in master and in 4 other branches 6-8-stable, 7-0-stable, 7-0-stable-spb, spb-stable

Remove all references tp the project code parameter from the API

Showing 12 changed files with 86 additions and 86 deletions   Show diff stats
doc/api/issues.md
  Diff comments   View file @8f01190
@@ -78,7 +78,7 @@ GET /projects/:id/issues @@ -78,7 +78,7 @@ GET /projects/:id/issues
78 78
79 Parameters: 79 Parameters:
80 80
81 -+ `id` (required) - The ID or code name of a project 81 ++ `id` (required) - The ID of a project
82 82
83 ## Single issue 83 ## Single issue
84 84
@@ -90,7 +90,7 @@ GET /projects/:id/issues/:issue_id @@ -90,7 +90,7 @@ GET /projects/:id/issues/:issue_id
90 90
91 Parameters: 91 Parameters:
92 92
93 -+ `id` (required) - The ID or code name of a project 93 ++ `id` (required) - The ID of a project
94 + `issue_id` (required) - The ID of a project issue 94 + `issue_id` (required) - The ID of a project issue
95 95
96 ```json 96 ```json
@@ -143,7 +143,7 @@ POST /projects/:id/issues @@ -143,7 +143,7 @@ POST /projects/:id/issues
143 143
144 Parameters: 144 Parameters:
145 145
146 -+ `id` (required) - The ID or code name of a project 146 ++ `id` (required) - The ID of a project
147 + `title` (required) - The title of an issue 147 + `title` (required) - The title of an issue
148 + `description` (optional) - The description of an issue 148 + `description` (optional) - The description of an issue
149 + `assignee_id` (optional) - The ID of a user to assign issue 149 + `assignee_id` (optional) - The ID of a user to assign issue
@@ -162,7 +162,7 @@ PUT /projects/:id/issues/:issue_id @@ -162,7 +162,7 @@ PUT /projects/:id/issues/:issue_id
162 162
163 Parameters: 163 Parameters:
164 164
165 -+ `id` (required) - The ID or code name of a project 165 ++ `id` (required) - The ID of a project
166 + `issue_id` (required) - The ID of a project's issue 166 + `issue_id` (required) - The ID of a project's issue
167 + `title` (optional) - The title of an issue 167 + `title` (optional) - The title of an issue
168 + `description` (optional) - The description of an issue 168 + `description` (optional) - The description of an issue
doc/api/merge_requests.md
  Diff comments   View file @8f01190
@@ -8,7 +8,7 @@ GET /projects/:id/merge_requests @@ -8,7 +8,7 @@ GET /projects/:id/merge_requests
8 8
9 Parameters: 9 Parameters:
10 10
11 -+ `id` (required) - The ID or code name of a project 11 ++ `id` (required) - The ID of a project
12 12
13 ```json 13 ```json
14 [ 14 [
@@ -50,7 +50,7 @@ GET /projects/:id/merge_request/:merge_request_id @@ -50,7 +50,7 @@ GET /projects/:id/merge_request/:merge_request_id
50 50
51 Parameters: 51 Parameters:
52 52
53 -+ `id` (required) - The ID or code name of a project 53 ++ `id` (required) - The ID of a project
54 + `merge_request_id` (required) - The ID of MR 54 + `merge_request_id` (required) - The ID of MR
55 55
56 ```json 56 ```json
@@ -92,7 +92,7 @@ POST /projects/:id/merge_requests @@ -92,7 +92,7 @@ POST /projects/:id/merge_requests
92 92
93 Parameters: 93 Parameters:
94 94
95 -+ `id` (required) - The ID or code name of a project 95 ++ `id` (required) - The ID of a project
96 + `source_branch` (required) - The source branch 96 + `source_branch` (required) - The source branch
97 + `target_branch` (required) - The target branch 97 + `target_branch` (required) - The target branch
98 + `assignee_id` - Assignee user ID 98 + `assignee_id` - Assignee user ID
@@ -136,7 +136,7 @@ PUT /projects/:id/merge_request/:merge_request_id @@ -136,7 +136,7 @@ PUT /projects/:id/merge_request/:merge_request_id
136 136
137 Parameters: 137 Parameters:
138 138
139 -+ `id` (required) - The ID or code name of a project 139 ++ `id` (required) - The ID of a project
140 + `merge_request_id` (required) - ID of MR 140 + `merge_request_id` (required) - ID of MR
141 + `source_branch` - The source branch 141 + `source_branch` - The source branch
142 + `target_branch` - The target branch 142 + `target_branch` - The target branch
@@ -182,7 +182,7 @@ POST /projects/:id/merge_request/:merge_request_id/comments @@ -182,7 +182,7 @@ POST /projects/:id/merge_request/:merge_request_id/comments
182 182
183 Parameters: 183 Parameters:
184 184
185 -+ `id` (required) - The ID or code name of a project 185 ++ `id` (required) - The ID of a project
186 + `merge_request_id` (required) - ID of MR 186 + `merge_request_id` (required) - ID of MR
187 + `note` (required) - Text of comment 187 + `note` (required) - Text of comment
188 188
doc/api/milestones.md
  Diff comments   View file @8f01190
@@ -8,7 +8,7 @@ GET /projects/:id/milestones @@ -8,7 +8,7 @@ GET /projects/:id/milestones
8 8
9 Parameters: 9 Parameters:
10 10
11 -+ `id` (required) - The ID or code name of a project 11 ++ `id` (required) - The ID of a project
12 12
13 ## Single milestone 13 ## Single milestone
14 14
@@ -20,7 +20,7 @@ GET /projects/:id/milestones/:milestone_id @@ -20,7 +20,7 @@ GET /projects/:id/milestones/:milestone_id
20 20
21 Parameters: 21 Parameters:
22 22
23 -+ `id` (required) - The ID or code name of a project 23 ++ `id` (required) - The ID of a project
24 + `milestone_id` (required) - The ID of a project milestone 24 + `milestone_id` (required) - The ID of a project milestone
25 25
26 ## New milestone 26 ## New milestone
@@ -33,7 +33,7 @@ POST /projects/:id/milestones @@ -33,7 +33,7 @@ POST /projects/:id/milestones
33 33
34 Parameters: 34 Parameters:
35 35
36 -+ `id` (required) - The ID or code name of a project 36 ++ `id` (required) - The ID of a project
37 + `milestone_id` (required) - The ID of a project milestone 37 + `milestone_id` (required) - The ID of a project milestone
38 + `title` (required) - The title of an milestone 38 + `title` (required) - The title of an milestone
39 + `description` (optional) - The description of the milestone 39 + `description` (optional) - The description of the milestone
@@ -49,7 +49,7 @@ PUT /projects/:id/milestones/:milestone_id @@ -49,7 +49,7 @@ PUT /projects/:id/milestones/:milestone_id
49 49
50 Parameters: 50 Parameters:
51 51
52 -+ `id` (required) - The ID or code name of a project 52 ++ `id` (required) - The ID of a project
53 + `milestone_id` (required) - The ID of a project milestone 53 + `milestone_id` (required) - The ID of a project milestone
54 + `title` (optional) - The title of a milestone 54 + `title` (optional) - The title of a milestone
55 + `description` (optional) - The description of a milestone 55 + `description` (optional) - The description of a milestone
doc/api/notes.md
  Diff comments   View file @8f01190
@@ -28,7 +28,7 @@ GET /projects/:id/notes @@ -28,7 +28,7 @@ GET /projects/:id/notes
28 28
29 Parameters: 29 Parameters:
30 30
31 -+ `id` (required) - The ID or code name of a project 31 ++ `id` (required) - The ID of a project
32 32
33 ### List issue notes 33 ### List issue notes
34 34
@@ -40,7 +40,7 @@ GET /projects/:id/issues/:issue_id/notes @@ -40,7 +40,7 @@ GET /projects/:id/issues/:issue_id/notes
40 40
41 Parameters: 41 Parameters:
42 42
43 -+ `id` (required) - The ID or code name of a project 43 ++ `id` (required) - The ID of a project
44 + `issue_id` (required) - The ID of an issue 44 + `issue_id` (required) - The ID of an issue
45 45
46 ### List snippet notes 46 ### List snippet notes
@@ -53,7 +53,7 @@ GET /projects/:id/snippets/:snippet_id/notes @@ -53,7 +53,7 @@ GET /projects/:id/snippets/:snippet_id/notes
53 53
54 Parameters: 54 Parameters:
55 55
56 -+ `id` (required) - The ID or code name of a project 56 ++ `id` (required) - The ID of a project
57 + `snippet_id` (required) - The ID of a snippet 57 + `snippet_id` (required) - The ID of a snippet
58 58
59 ## Single note 59 ## Single note
@@ -68,7 +68,7 @@ GET /projects/:id/notes/:note_id @@ -68,7 +68,7 @@ GET /projects/:id/notes/:note_id
68 68
69 Parameters: 69 Parameters:
70 70
71 -+ `id` (required) - The ID or code name of a project 71 ++ `id` (required) - The ID of a project
72 + `note_id` (required) - The ID of a wall note 72 + `note_id` (required) - The ID of a wall note
73 73
74 ### Single issue note 74 ### Single issue note
@@ -81,7 +81,7 @@ GET /projects/:id/issues/:issue_id/:notes/:note_id @@ -81,7 +81,7 @@ GET /projects/:id/issues/:issue_id/:notes/:note_id
81 81
82 Parameters: 82 Parameters:
83 83
84 -+ `id` (required) - The ID or code name of a project 84 ++ `id` (required) - The ID of a project
85 + `issue_id` (required) - The ID of a project issue 85 + `issue_id` (required) - The ID of a project issue
86 + `note_id` (required) - The ID of an issue note 86 + `note_id` (required) - The ID of an issue note
87 87
@@ -95,7 +95,7 @@ GET /projects/:id/issues/:snippet_id/:notes/:note_id @@ -95,7 +95,7 @@ GET /projects/:id/issues/:snippet_id/:notes/:note_id
95 95
96 Parameters: 96 Parameters:
97 97
98 -+ `id` (required) - The ID or code name of a project 98 ++ `id` (required) - The ID of a project
99 + `snippet_id` (required) - The ID of a project snippet 99 + `snippet_id` (required) - The ID of a project snippet
100 + `note_id` (required) - The ID of an snippet note 100 + `note_id` (required) - The ID of an snippet note
101 101
@@ -111,7 +111,7 @@ POST /projects/:id/notes @@ -111,7 +111,7 @@ POST /projects/:id/notes
111 111
112 Parameters: 112 Parameters:
113 113
114 -+ `id` (required) - The ID or code name of a project 114 ++ `id` (required) - The ID of a project
115 + `body` (required) - The content of a note 115 + `body` (required) - The content of a note
116 116
117 Will return created note with status `201 Created` on success, or `404 Not found` on fail. 117 Will return created note with status `201 Created` on success, or `404 Not found` on fail.
@@ -127,7 +127,7 @@ POST /projects/:id/issues/:issue_id/notes @@ -127,7 +127,7 @@ POST /projects/:id/issues/:issue_id/notes
127 127
128 Parameters: 128 Parameters:
129 129
130 -+ `id` (required) - The ID or code name of a project 130 ++ `id` (required) - The ID of a project
131 + `issue_id` (required) - The ID of an issue 131 + `issue_id` (required) - The ID of an issue
132 + `body` (required) - The content of a note 132 + `body` (required) - The content of a note
133 133
@@ -143,7 +143,7 @@ POST /projects/:id/snippets/:snippet_id/notes @@ -143,7 +143,7 @@ POST /projects/:id/snippets/:snippet_id/notes
143 143
144 Parameters: 144 Parameters:
145 145
146 -+ `id` (required) - The ID or code name of a project 146 ++ `id` (required) - The ID of a project
147 + `snippet_id` (required) - The ID of an snippet 147 + `snippet_id` (required) - The ID of an snippet
148 + `body` (required) - The content of a note 148 + `body` (required) - The content of a note
149 149
doc/api/projects.md
  Diff comments   View file @8f01190
@@ -63,7 +63,7 @@ GET /projects/:id @@ -63,7 +63,7 @@ GET /projects/:id
63 63
64 Parameters: 64 Parameters:
65 65
66 -+ `id` (required) - The ID or code name of a project 66 ++ `id` (required) - The ID of a project
67 67
68 ```json 68 ```json
69 { 69 {
@@ -121,7 +121,7 @@ GET /projects/:id/members @@ -121,7 +121,7 @@ GET /projects/:id/members
121 121
122 Parameters: 122 Parameters:
123 123
124 -+ `id` (required) - The ID or code name of a project 124 ++ `id` (required) - The ID of a project
125 + `query` - Query string 125 + `query` - Query string
126 126
127 ## Get project team member 127 ## Get project team member
@@ -134,7 +134,7 @@ GET /projects/:id/members/:user_id @@ -134,7 +134,7 @@ GET /projects/:id/members/:user_id
134 134
135 Parameters: 135 Parameters:
136 136
137 -+ `id` (required) - The ID or code name of a project 137 ++ `id` (required) - The ID of a project
138 + `user_id` (required) - The ID of a user 138 + `user_id` (required) - The ID of a user
139 139
140 ```json 140 ```json
@@ -160,7 +160,7 @@ POST /projects/:id/members @@ -160,7 +160,7 @@ POST /projects/:id/members
160 160
161 Parameters: 161 Parameters:
162 162
163 -+ `id` (required) - The ID or code name of a project 163 ++ `id` (required) - The ID of a project
164 + `user_id` (required) - The ID of a user to add 164 + `user_id` (required) - The ID of a user to add
165 + `access_level` (required) - Project access level 165 + `access_level` (required) - Project access level
166 166
@@ -176,7 +176,7 @@ PUT /projects/:id/members/:user_id @@ -176,7 +176,7 @@ PUT /projects/:id/members/:user_id
176 176
177 Parameters: 177 Parameters:
178 178
179 -+ `id` (required) - The ID or code name of a project 179 ++ `id` (required) - The ID of a project
180 + `user_id` (required) - The ID of a team member 180 + `user_id` (required) - The ID of a team member
181 + `access_level` (required) - Project access level 181 + `access_level` (required) - Project access level
182 182
@@ -192,7 +192,7 @@ DELETE /projects/:id/members/:user_id @@ -192,7 +192,7 @@ DELETE /projects/:id/members/:user_id
192 192
193 Parameters: 193 Parameters:
194 194
195 -+ `id` (required) - The ID or code name of a project 195 ++ `id` (required) - The ID of a project
196 + `user_id` (required) - The ID of a team member 196 + `user_id` (required) - The ID of a team member
197 197
198 Status code `200` will be returned on success. 198 Status code `200` will be returned on success.
@@ -207,7 +207,7 @@ GET /projects/:id/hooks @@ -207,7 +207,7 @@ GET /projects/:id/hooks
207 207
208 Parameters: 208 Parameters:
209 209
210 -+ `id` (required) - The ID or code name of a project 210 ++ `id` (required) - The ID of a project
211 211
212 Will return hooks with status `200 OK` on success, or `404 Not found` on fail. 212 Will return hooks with status `200 OK` on success, or `404 Not found` on fail.
213 213
@@ -221,7 +221,7 @@ GET /projects/:id/hooks/:hook_id @@ -221,7 +221,7 @@ GET /projects/:id/hooks/:hook_id
221 221
222 Parameters: 222 Parameters:
223 223
224 -+ `id` (required) - The ID or code name of a project 224 ++ `id` (required) - The ID of a project
225 + `hook_id` (required) - The ID of a project hook 225 + `hook_id` (required) - The ID of a project hook
226 226
227 Will return hook with status `200 OK` on success, or `404 Not found` on fail. 227 Will return hook with status `200 OK` on success, or `404 Not found` on fail.
@@ -236,7 +236,7 @@ POST /projects/:id/hooks @@ -236,7 +236,7 @@ POST /projects/:id/hooks
236 236
237 Parameters: 237 Parameters:
238 238
239 -+ `id` (required) - The ID or code name of a project 239 ++ `id` (required) - The ID of a project
240 + `url` (required) - The hook URL 240 + `url` (required) - The hook URL
241 241
242 Will return status `201 Created` on success, or `404 Not found` on fail. 242 Will return status `201 Created` on success, or `404 Not found` on fail.
@@ -251,7 +251,7 @@ PUT /projects/:id/hooks/:hook_id @@ -251,7 +251,7 @@ PUT /projects/:id/hooks/:hook_id
251 251
252 Parameters: 252 Parameters:
253 253
254 -+ `id` (required) - The ID or code name of a project 254 ++ `id` (required) - The ID of a project
255 + `hook_id` (required) - The ID of a project hook 255 + `hook_id` (required) - The ID of a project hook
256 + `url` (required) - The hook URL 256 + `url` (required) - The hook URL
257 257
@@ -268,7 +268,7 @@ DELETE /projects/:id/hooks @@ -268,7 +268,7 @@ DELETE /projects/:id/hooks
268 268
269 Parameters: 269 Parameters:
270 270
271 -+ `id` (required) - The ID or code name of a project 271 ++ `id` (required) - The ID of a project
272 + `hook_id` (required) - The ID of hook to delete 272 + `hook_id` (required) - The ID of hook to delete
273 273
274 Will return status `200 OK` on success, or `404 Not found` on fail. 274 Will return status `200 OK` on success, or `404 Not found` on fail.
doc/api/repositories.md
  Diff comments   View file @8f01190
@@ -8,7 +8,7 @@ GET /projects/:id/repository/branches @@ -8,7 +8,7 @@ GET /projects/:id/repository/branches
8 8
9 Parameters: 9 Parameters:
10 10
11 -+ `id` (required) - The ID or code name of a project 11 ++ `id` (required) - The ID of a project
12 12
13 ```json 13 ```json
14 [ 14 [
@@ -48,7 +48,7 @@ GET /projects/:id/repository/branches/:branch @@ -48,7 +48,7 @@ GET /projects/:id/repository/branches/:branch
48 48
49 Parameters: 49 Parameters:
50 50
51 -+ `id` (required) - The ID or code name of a project 51 ++ `id` (required) - The ID of a project
52 + `branch` (required) - The name of the branch 52 + `branch` (required) - The name of the branch
53 53
54 ```json 54 ```json
@@ -87,7 +87,7 @@ GET /projects/:id/repository/tags @@ -87,7 +87,7 @@ GET /projects/:id/repository/tags
87 87
88 Parameters: 88 Parameters:
89 89
90 -+ `id` (required) - The ID or code name of a project 90 ++ `id` (required) - The ID of a project
91 91
92 ```json 92 ```json
93 [ 93 [
@@ -125,7 +125,7 @@ GET /projects/:id/repository/commits @@ -125,7 +125,7 @@ GET /projects/:id/repository/commits
125 125
126 Parameters: 126 Parameters:
127 127
128 -+ `id` (required) - The ID or code name of a project 128 ++ `id` (required) - The ID of a project
129 + `ref_name` (optional) - The name of a repository branch or tag 129 + `ref_name` (optional) - The name of a repository branch or tag
130 130
131 ```json 131 ```json
@@ -159,7 +159,7 @@ GET /projects/:id/repository/commits/:sha/blob @@ -159,7 +159,7 @@ GET /projects/:id/repository/commits/:sha/blob
159 159
160 Parameters: 160 Parameters:
161 161
162 -+ `id` (required) - The ID or code name of a project 162 ++ `id` (required) - The ID of a project
163 + `sha` (required) - The commit or branch name 163 + `sha` (required) - The commit or branch name
164 + `filepath` (required) - The path the file 164 + `filepath` (required) - The path the file
165 165
doc/api/snippets.md
  Diff comments   View file @8f01190
@@ -8,7 +8,7 @@ GET /projects/:id/snippets @@ -8,7 +8,7 @@ GET /projects/:id/snippets
8 8
9 Parameters: 9 Parameters:
10 10
11 -+ `id` (required) - The ID or code name of a project 11 ++ `id` (required) - The ID of a project
12 12
13 ## Single snippet 13 ## Single snippet
14 14
@@ -20,7 +20,7 @@ GET /projects/:id/snippets/:snippet_id @@ -20,7 +20,7 @@ GET /projects/:id/snippets/:snippet_id
20 20
21 Parameters: 21 Parameters:
22 22
23 -+ `id` (required) - The ID or code name of a project 23 ++ `id` (required) - The ID of a project
24 + `snippet_id` (required) - The ID of a project's snippet 24 + `snippet_id` (required) - The ID of a project's snippet
25 25
26 ```json 26 ```json
@@ -52,7 +52,7 @@ GET /projects/:id/snippets/:snippet_id/raw @@ -52,7 +52,7 @@ GET /projects/:id/snippets/:snippet_id/raw
52 52
53 Parameters: 53 Parameters:
54 54
55 -+ `id` (required) - The ID or code name of a project 55 ++ `id` (required) - The ID of a project
56 + `snippet_id` (required) - The ID of a project's snippet 56 + `snippet_id` (required) - The ID of a project's snippet
57 57
58 ## New snippet 58 ## New snippet
@@ -65,7 +65,7 @@ POST /projects/:id/snippets @@ -65,7 +65,7 @@ POST /projects/:id/snippets
65 65
66 Parameters: 66 Parameters:
67 67
68 -+ `id` (required) - The ID or code name of a project 68 ++ `id` (required) - The ID of a project
69 + `title` (required) - The title of a snippet 69 + `title` (required) - The title of a snippet
70 + `file_name` (required) - The name of a snippet file 70 + `file_name` (required) - The name of a snippet file
71 + `lifetime` (optional) - The expiration date of a snippet 71 + `lifetime` (optional) - The expiration date of a snippet
@@ -83,7 +83,7 @@ PUT /projects/:id/snippets/:snippet_id @@ -83,7 +83,7 @@ PUT /projects/:id/snippets/:snippet_id
83 83
84 Parameters: 84 Parameters:
85 85
86 -+ `id` (required) - The ID or code name of a project 86 ++ `id` (required) - The ID of a project
87 + `snippet_id` (required) - The ID of a project's snippet 87 + `snippet_id` (required) - The ID of a project's snippet
88 + `title` (optional) - The title of a snippet 88 + `title` (optional) - The title of a snippet
89 + `file_name` (optional) - The name of a snippet file 89 + `file_name` (optional) - The name of a snippet file
@@ -102,7 +102,7 @@ DELETE /projects/:id/snippets/:snippet_id @@ -102,7 +102,7 @@ DELETE /projects/:id/snippets/:snippet_id
102 102
103 Parameters: 103 Parameters:
104 104
105 -+ `id` (required) - The ID or code name of a project 105 ++ `id` (required) - The ID of a project
106 + `snippet_id` (required) - The ID of a project's snippet 106 + `snippet_id` (required) - The ID of a project's snippet
107 107
108 Status code `200` will be returned on success. 108 Status code `200` will be returned on success.
lib/api/issues.rb
  Diff comments   View file @8f01190
@@ -17,7 +17,7 @@ module Gitlab @@ -17,7 +17,7 @@ module Gitlab
17 # Get a list of project issues 17 # Get a list of project issues
18 # 18 #
19 # Parameters: 19 # Parameters:
20 - # id (required) - The ID or code name of a project 20 + # id (required) - The ID of a project
21 # Example Request: 21 # Example Request:
22 # GET /projects/:id/issues 22 # GET /projects/:id/issues
23 get ":id/issues" do 23 get ":id/issues" do
@@ -27,7 +27,7 @@ module Gitlab @@ -27,7 +27,7 @@ module Gitlab
27 # Get a single project issue 27 # Get a single project issue
28 # 28 #
29 # Parameters: 29 # Parameters:
30 - # id (required) - The ID or code name of a project 30 + # id (required) - The ID of a project
31 # issue_id (required) - The ID of a project issue 31 # issue_id (required) - The ID of a project issue
32 # Example Request: 32 # Example Request:
33 # GET /projects/:id/issues/:issue_id 33 # GET /projects/:id/issues/:issue_id
@@ -39,7 +39,7 @@ module Gitlab @@ -39,7 +39,7 @@ module Gitlab
39 # Create a new project issue 39 # Create a new project issue
40 # 40 #
41 # Parameters: 41 # Parameters:
42 - # id (required) - The ID or code name of a project 42 + # id (required) - The ID of a project
43 # title (required) - The title of an issue 43 # title (required) - The title of an issue
44 # description (optional) - The description of an issue 44 # description (optional) - The description of an issue
45 # assignee_id (optional) - The ID of a user to assign issue 45 # assignee_id (optional) - The ID of a user to assign issue
@@ -62,7 +62,7 @@ module Gitlab @@ -62,7 +62,7 @@ module Gitlab
62 # Update an existing issue 62 # Update an existing issue
63 # 63 #
64 # Parameters: 64 # Parameters:
65 - # id (required) - The ID or code name of a project 65 + # id (required) - The ID of a project
66 # issue_id (required) - The ID of a project issue 66 # issue_id (required) - The ID of a project issue
67 # title (optional) - The title of an issue 67 # title (optional) - The title of an issue
68 # description (optional) - The description of an issue 68 # description (optional) - The description of an issue
@@ -88,7 +88,7 @@ module Gitlab @@ -88,7 +88,7 @@ module Gitlab
88 # Delete a project issue (deprecated) 88 # Delete a project issue (deprecated)
89 # 89 #
90 # Parameters: 90 # Parameters:
91 - # id (required) - The ID or code name of a project 91 + # id (required) - The ID of a project
92 # issue_id (required) - The ID of a project issue 92 # issue_id (required) - The ID of a project issue
93 # Example Request: 93 # Example Request:
94 # DELETE /projects/:id/issues/:issue_id 94 # DELETE /projects/:id/issues/:issue_id
lib/api/merge_requests.rb
  Diff comments   View file @8f01190
@@ -8,7 +8,7 @@ module Gitlab @@ -8,7 +8,7 @@ module Gitlab
8 # List merge requests 8 # List merge requests
9 # 9 #
10 # Parameters: 10 # Parameters:
11 - # id (required) - The ID or code name of a project 11 + # id (required) - The ID of a project
12 # 12 #
13 # Example: 13 # Example:
14 # GET /projects/:id/merge_requests 14 # GET /projects/:id/merge_requests
@@ -22,7 +22,7 @@ module Gitlab @@ -22,7 +22,7 @@ module Gitlab
22 # Show MR 22 # Show MR
23 # 23 #
24 # Parameters: 24 # Parameters:
25 - # id (required) - The ID or code name of a project 25 + # id (required) - The ID of a project
26 # merge_request_id (required) - The ID of MR 26 # merge_request_id (required) - The ID of MR
27 # 27 #
28 # Example: 28 # Example:
@@ -40,7 +40,7 @@ module Gitlab @@ -40,7 +40,7 @@ module Gitlab
40 # 40 #
41 # Parameters: 41 # Parameters:
42 # 42 #
43 - # id (required) - The ID or code name of a project 43 + # id (required) - The ID of a project
44 # source_branch (required) - The source branch 44 # source_branch (required) - The source branch
45 # target_branch (required) - The target branch 45 # target_branch (required) - The target branch
46 # assignee_id - Assignee user ID 46 # assignee_id - Assignee user ID
@@ -67,7 +67,7 @@ module Gitlab @@ -67,7 +67,7 @@ module Gitlab
67 # Update MR 67 # Update MR
68 # 68 #
69 # Parameters: 69 # Parameters:
70 - # id (required) - The ID or code name of a project 70 + # id (required) - The ID of a project
71 # merge_request_id (required) - ID of MR 71 # merge_request_id (required) - ID of MR
72 # source_branch - The source branch 72 # source_branch - The source branch
73 # target_branch - The target branch 73 # target_branch - The target branch
@@ -95,7 +95,7 @@ module Gitlab @@ -95,7 +95,7 @@ module Gitlab
95 # Post comment to merge request 95 # Post comment to merge request
96 # 96 #
97 # Parameters: 97 # Parameters:
98 - # id (required) - The ID or code name of a project 98 + # id (required) - The ID of a project
99 # merge_request_id (required) - ID of MR 99 # merge_request_id (required) - ID of MR
100 # note (required) - Text of comment 100 # note (required) - Text of comment
101 # Examples: 101 # Examples:
lib/api/milestones.rb
  Diff comments   View file @8f01190
@@ -7,7 +7,7 @@ module Gitlab @@ -7,7 +7,7 @@ module Gitlab
7 # Get a list of project milestones 7 # Get a list of project milestones
8 # 8 #
9 # Parameters: 9 # Parameters:
10 - # id (required) - The ID or code name of a project 10 + # id (required) - The ID of a project
11 # Example Request: 11 # Example Request:
12 # GET /projects/:id/milestones 12 # GET /projects/:id/milestones
13 get ":id/milestones" do 13 get ":id/milestones" do
@@ -19,7 +19,7 @@ module Gitlab @@ -19,7 +19,7 @@ module Gitlab
19 # Get a single project milestone 19 # Get a single project milestone
20 # 20 #
21 # Parameters: 21 # Parameters:
22 - # id (required) - The ID or code name of a project 22 + # id (required) - The ID of a project
23 # milestone_id (required) - The ID of a project milestone 23 # milestone_id (required) - The ID of a project milestone
24 # Example Request: 24 # Example Request:
25 # GET /projects/:id/milestones/:milestone_id 25 # GET /projects/:id/milestones/:milestone_id
@@ -33,7 +33,7 @@ module Gitlab @@ -33,7 +33,7 @@ module Gitlab
33 # Create a new project milestone 33 # Create a new project milestone
34 # 34 #
35 # Parameters: 35 # Parameters:
36 - # id (required) - The ID or code name of the project 36 + # id (required) - The ID of the project
37 # title (required) - The title of the milestone 37 # title (required) - The title of the milestone
38 # description (optional) - The description of the milestone 38 # description (optional) - The description of the milestone
39 # due_date (optional) - The due date of the milestone 39 # due_date (optional) - The due date of the milestone
@@ -54,7 +54,7 @@ module Gitlab @@ -54,7 +54,7 @@ module Gitlab
54 # Update an existing project milestone 54 # Update an existing project milestone
55 # 55 #
56 # Parameters: 56 # Parameters:
57 - # id (required) - The ID or code name of a project 57 + # id (required) - The ID of a project
58 # milestone_id (required) - The ID of a project milestone 58 # milestone_id (required) - The ID of a project milestone
59 # title (optional) - The title of a milestone 59 # title (optional) - The title of a milestone
60 # description (optional) - The description of a milestone 60 # description (optional) - The description of a milestone
lib/api/notes.rb
  Diff comments   View file @8f01190
@@ -9,7 +9,7 @@ module Gitlab @@ -9,7 +9,7 @@ module Gitlab
9 # Get a list of project wall notes 9 # Get a list of project wall notes
10 # 10 #
11 # Parameters: 11 # Parameters:
12 - # id (required) - The ID or code name of a project 12 + # id (required) - The ID of a project
13 # Example Request: 13 # Example Request:
14 # GET /projects/:id/notes 14 # GET /projects/:id/notes
15 get ":id/notes" do 15 get ":id/notes" do
@@ -20,7 +20,7 @@ module Gitlab @@ -20,7 +20,7 @@ module Gitlab
20 # Get a single project wall note 20 # Get a single project wall note
21 # 21 #
22 # Parameters: 22 # Parameters:
23 - # id (required) - The ID or code name of a project 23 + # id (required) - The ID of a project
24 # note_id (required) - The ID of a note 24 # note_id (required) - The ID of a note
25 # Example Request: 25 # Example Request:
26 # GET /projects/:id/notes/:note_id 26 # GET /projects/:id/notes/:note_id
@@ -32,7 +32,7 @@ module Gitlab @@ -32,7 +32,7 @@ module Gitlab
32 # Create a new project wall note 32 # Create a new project wall note
33 # 33 #
34 # Parameters: 34 # Parameters:
35 - # id (required) - The ID or code name of a project 35 + # id (required) - The ID of a project
36 # body (required) - The content of a note 36 # body (required) - The content of a note
37 # Example Request: 37 # Example Request:
38 # POST /projects/:id/notes 38 # POST /projects/:id/notes
@@ -54,7 +54,7 @@ module Gitlab @@ -54,7 +54,7 @@ module Gitlab
54 # Get a list of project +noteable+ notes 54 # Get a list of project +noteable+ notes
55 # 55 #
56 # Parameters: 56 # Parameters:
57 - # id (required) - The ID or code name of a project 57 + # id (required) - The ID of a project
58 # noteable_id (required) - The ID of an issue or snippet 58 # noteable_id (required) - The ID of an issue or snippet
59 # Example Request: 59 # Example Request:
60 # GET /projects/:id/issues/:noteable_id/notes 60 # GET /projects/:id/issues/:noteable_id/notes
@@ -67,7 +67,7 @@ module Gitlab @@ -67,7 +67,7 @@ module Gitlab
67 # Get a single +noteable+ note 67 # Get a single +noteable+ note
68 # 68 #
69 # Parameters: 69 # Parameters:
70 - # id (required) - The ID or code name of a project 70 + # id (required) - The ID of a project
71 # noteable_id (required) - The ID of an issue or snippet 71 # noteable_id (required) - The ID of an issue or snippet
72 # note_id (required) - The ID of a note 72 # note_id (required) - The ID of a note
73 # Example Request: 73 # Example Request:
@@ -82,7 +82,7 @@ module Gitlab @@ -82,7 +82,7 @@ module Gitlab
82 # Create a new +noteable+ note 82 # Create a new +noteable+ note
83 # 83 #
84 # Parameters: 84 # Parameters:
85 - # id (required) - The ID or code name of a project 85 + # id (required) - The ID of a project
86 # noteable_id (required) - The ID of an issue or snippet 86 # noteable_id (required) - The ID of an issue or snippet
87 # body (required) - The content of a note 87 # body (required) - The content of a note
88 # Example Request: 88 # Example Request:
lib/api/projects.rb
  Diff comments   View file @8f01190
@@ -16,7 +16,7 @@ module Gitlab @@ -16,7 +16,7 @@ module Gitlab
16 # Get a single project 16 # Get a single project
17 # 17 #
18 # Parameters: 18 # Parameters:
19 - # id (required) - The ID or code name of a project 19 + # id (required) - The ID of a project
20 # Example Request: 20 # Example Request:
21 # GET /projects/:id 21 # GET /projects/:id
22 get ":id" do 22 get ":id" do
@@ -55,7 +55,7 @@ module Gitlab @@ -55,7 +55,7 @@ module Gitlab
55 # Get a project team members 55 # Get a project team members
56 # 56 #
57 # Parameters: 57 # Parameters:
58 - # id (required) - The ID or code name of a project 58 + # id (required) - The ID of a project
59 # query - Query string 59 # query - Query string
60 # Example Request: 60 # Example Request:
61 # GET /projects/:id/members 61 # GET /projects/:id/members
@@ -71,7 +71,7 @@ module Gitlab @@ -71,7 +71,7 @@ module Gitlab
71 # Get a project team members 71 # Get a project team members
72 # 72 #
73 # Parameters: 73 # Parameters:
74 - # id (required) - The ID or code name of a project 74 + # id (required) - The ID of a project
75 # user_id (required) - The ID of a user 75 # user_id (required) - The ID of a user
76 # Example Request: 76 # Example Request:
77 # GET /projects/:id/members/:user_id 77 # GET /projects/:id/members/:user_id
@@ -83,7 +83,7 @@ module Gitlab @@ -83,7 +83,7 @@ module Gitlab
83 # Add a new project team member 83 # Add a new project team member
84 # 84 #
85 # Parameters: 85 # Parameters:
86 - # id (required) - The ID or code name of a project 86 + # id (required) - The ID of a project
87 # user_id (required) - The ID of a user 87 # user_id (required) - The ID of a user
88 # access_level (required) - Project access level 88 # access_level (required) - Project access level
89 # Example Request: 89 # Example Request:
@@ -106,7 +106,7 @@ module Gitlab @@ -106,7 +106,7 @@ module Gitlab
106 # Update project team member 106 # Update project team member
107 # 107 #
108 # Parameters: 108 # Parameters:
109 - # id (required) - The ID or code name of a project 109 + # id (required) - The ID of a project
110 # user_id (required) - The ID of a team member 110 # user_id (required) - The ID of a team member
111 # access_level (required) - Project access level 111 # access_level (required) - Project access level
112 # Example Request: 112 # Example Request:
@@ -126,7 +126,7 @@ module Gitlab @@ -126,7 +126,7 @@ module Gitlab
126 # Remove a team member from project 126 # Remove a team member from project
127 # 127 #
128 # Parameters: 128 # Parameters:
129 - # id (required) - The ID or code name of a project 129 + # id (required) - The ID of a project
130 # user_id (required) - The ID of a team member 130 # user_id (required) - The ID of a team member
131 # Example Request: 131 # Example Request:
132 # DELETE /projects/:id/members/:user_id 132 # DELETE /projects/:id/members/:user_id
@@ -139,7 +139,7 @@ module Gitlab @@ -139,7 +139,7 @@ module Gitlab
139 # Get project hooks 139 # Get project hooks
140 # 140 #
141 # Parameters: 141 # Parameters:
142 - # id (required) - The ID or code name of a project 142 + # id (required) - The ID of a project
143 # Example Request: 143 # Example Request:
144 # GET /projects/:id/hooks 144 # GET /projects/:id/hooks
145 get ":id/hooks" do 145 get ":id/hooks" do
@@ -151,7 +151,7 @@ module Gitlab @@ -151,7 +151,7 @@ module Gitlab
151 # Get a project hook 151 # Get a project hook
152 # 152 #
153 # Parameters: 153 # Parameters:
154 - # id (required) - The ID or code name of a project 154 + # id (required) - The ID of a project
155 # hook_id (required) - The ID of a project hook 155 # hook_id (required) - The ID of a project hook
156 # Example Request: 156 # Example Request:
157 # GET /projects/:id/hooks/:hook_id 157 # GET /projects/:id/hooks/:hook_id
@@ -164,7 +164,7 @@ module Gitlab @@ -164,7 +164,7 @@ module Gitlab
164 # Add hook to project 164 # Add hook to project
165 # 165 #
166 # Parameters: 166 # Parameters:
167 - # id (required) - The ID or code name of a project 167 + # id (required) - The ID of a project
168 # url (required) - The hook URL 168 # url (required) - The hook URL
169 # Example Request: 169 # Example Request:
170 # POST /projects/:id/hooks 170 # POST /projects/:id/hooks
@@ -181,7 +181,7 @@ module Gitlab @@ -181,7 +181,7 @@ module Gitlab
181 # Update an existing project hook 181 # Update an existing project hook
182 # 182 #
183 # Parameters: 183 # Parameters:
184 - # id (required) - The ID or code name of a project 184 + # id (required) - The ID of a project
185 # hook_id (required) - The ID of a project hook 185 # hook_id (required) - The ID of a project hook
186 # url (required) - The hook URL 186 # url (required) - The hook URL
187 # Example Request: 187 # Example Request:
@@ -202,7 +202,7 @@ module Gitlab @@ -202,7 +202,7 @@ module Gitlab
202 # Delete project hook 202 # Delete project hook
203 # 203 #
204 # Parameters: 204 # Parameters:
205 - # id (required) - The ID or code name of a project 205 + # id (required) - The ID of a project
206 # hook_id (required) - The ID of hook to delete 206 # hook_id (required) - The ID of hook to delete
207 # Example Request: 207 # Example Request:
208 # DELETE /projects/:id/hooks 208 # DELETE /projects/:id/hooks
@@ -215,7 +215,7 @@ module Gitlab @@ -215,7 +215,7 @@ module Gitlab
215 # Get a project repository branches 215 # Get a project repository branches
216 # 216 #
217 # Parameters: 217 # Parameters:
218 - # id (required) - The ID or code name of a project 218 + # id (required) - The ID of a project
219 # Example Request: 219 # Example Request:
220 # GET /projects/:id/repository/branches 220 # GET /projects/:id/repository/branches
221 get ":id/repository/branches" do 221 get ":id/repository/branches" do
@@ -225,7 +225,7 @@ module Gitlab @@ -225,7 +225,7 @@ module Gitlab
225 # Get a single branch 225 # Get a single branch
226 # 226 #
227 # Parameters: 227 # Parameters:
228 - # id (required) - The ID or code name of a project 228 + # id (required) - The ID of a project
229 # branch (required) - The name of the branch 229 # branch (required) - The name of the branch
230 # Example Request: 230 # Example Request:
231 # GET /projects/:id/repository/branches/:branch 231 # GET /projects/:id/repository/branches/:branch
@@ -237,7 +237,7 @@ module Gitlab @@ -237,7 +237,7 @@ module Gitlab
237 # Get a project repository tags 237 # Get a project repository tags
238 # 238 #
239 # Parameters: 239 # Parameters:
240 - # id (required) - The ID or code name of a project 240 + # id (required) - The ID of a project
241 # Example Request: 241 # Example Request:
242 # GET /projects/:id/repository/tags 242 # GET /projects/:id/repository/tags
243 get ":id/repository/tags" do 243 get ":id/repository/tags" do
@@ -247,7 +247,7 @@ module Gitlab @@ -247,7 +247,7 @@ module Gitlab
247 # Get a project repository commits 247 # Get a project repository commits
248 # 248 #
249 # Parameters: 249 # Parameters:
250 - # id (required) - The ID or code name of a project 250 + # id (required) - The ID of a project
251 # ref_name (optional) - The name of a repository branch or tag 251 # ref_name (optional) - The name of a repository branch or tag
252 # Example Request: 252 # Example Request:
253 # GET /projects/:id/repository/commits 253 # GET /projects/:id/repository/commits
@@ -265,7 +265,7 @@ module Gitlab @@ -265,7 +265,7 @@ module Gitlab
265 # Get a project snippets 265 # Get a project snippets
266 # 266 #
267 # Parameters: 267 # Parameters:
268 - # id (required) - The ID or code name of a project 268 + # id (required) - The ID of a project
269 # Example Request: 269 # Example Request:
270 # GET /projects/:id/snippets 270 # GET /projects/:id/snippets
271 get ":id/snippets" do 271 get ":id/snippets" do
@@ -275,7 +275,7 @@ module Gitlab @@ -275,7 +275,7 @@ module Gitlab
275 # Get a project snippet 275 # Get a project snippet
276 # 276 #
277 # Parameters: 277 # Parameters:
278 - # id (required) - The ID or code name of a project 278 + # id (required) - The ID of a project
279 # snippet_id (required) - The ID of a project snippet 279 # snippet_id (required) - The ID of a project snippet
280 # Example Request: 280 # Example Request:
281 # GET /projects/:id/snippets/:snippet_id 281 # GET /projects/:id/snippets/:snippet_id
@@ -287,7 +287,7 @@ module Gitlab @@ -287,7 +287,7 @@ module Gitlab
287 # Create a new project snippet 287 # Create a new project snippet
288 # 288 #
289 # Parameters: 289 # Parameters:
290 - # id (required) - The ID or code name of a project 290 + # id (required) - The ID of a project
291 # title (required) - The title of a snippet 291 # title (required) - The title of a snippet
292 # file_name (required) - The name of a snippet file 292 # file_name (required) - The name of a snippet file
293 # lifetime (optional) - The expiration date of a snippet 293 # lifetime (optional) - The expiration date of a snippet
@@ -313,7 +313,7 @@ module Gitlab @@ -313,7 +313,7 @@ module Gitlab
313 # Update an existing project snippet 313 # Update an existing project snippet
314 # 314 #
315 # Parameters: 315 # Parameters:
316 - # id (required) - The ID or code name of a project 316 + # id (required) - The ID of a project
317 # snippet_id (required) - The ID of a project snippet 317 # snippet_id (required) - The ID of a project snippet
318 # title (optional) - The title of a snippet 318 # title (optional) - The title of a snippet
319 # file_name (optional) - The name of a snippet file 319 # file_name (optional) - The name of a snippet file
@@ -339,7 +339,7 @@ module Gitlab @@ -339,7 +339,7 @@ module Gitlab
339 # Delete a project snippet 339 # Delete a project snippet
340 # 340 #
341 # Parameters: 341 # Parameters:
342 - # id (required) - The ID or code name of a project 342 + # id (required) - The ID of a project
343 # snippet_id (required) - The ID of a project snippet 343 # snippet_id (required) - The ID of a project snippet
344 # Example Request: 344 # Example Request:
345 # DELETE /projects/:id/snippets/:snippet_id 345 # DELETE /projects/:id/snippets/:snippet_id
@@ -353,7 +353,7 @@ module Gitlab @@ -353,7 +353,7 @@ module Gitlab
353 # Get a raw project snippet 353 # Get a raw project snippet
354 # 354 #
355 # Parameters: 355 # Parameters:
356 - # id (required) - The ID or code name of a project 356 + # id (required) - The ID of a project
357 # snippet_id (required) - The ID of a project snippet 357 # snippet_id (required) - The ID of a project snippet
358 # Example Request: 358 # Example Request:
359 # GET /projects/:id/snippets/:snippet_id/raw 359 # GET /projects/:id/snippets/:snippet_id/raw
@@ -366,7 +366,7 @@ module Gitlab @@ -366,7 +366,7 @@ module Gitlab
366 # Get a raw file contents 366 # Get a raw file contents
367 # 367 #
368 # Parameters: 368 # Parameters:
369 - # id (required) - The ID or code name of a project 369 + # id (required) - The ID of a project
370 # sha (required) - The commit or branch name 370 # sha (required) - The commit or branch name
371 # filepath (required) - The path to the file to display 371 # filepath (required) - The path to the file to display
372 # Example Request: 372 # Example Request: