Commit 8fe58ed541e04f81de8e401c17d021aa4092a526
Exists in
master
and in
4 other branches
Merge pull request #2330 from gitlabhq/v4.0-api-fixes
V4.0 API fixes
Showing
16 changed files
with
90 additions
and
95 deletions
Show diff stats
app/views/layouts/_init_auto_complete.html.haml
| 1 | :javascript | 1 | :javascript |
| 2 | $(function() { | 2 | $(function() { |
| 3 | - GitLab.GfmAutoComplete.Members.url = "#{ "/api/v2/projects/#{@project.id}/members" if @project }"; | 3 | + GitLab.GfmAutoComplete.Members.url = "#{ "/api/v3/projects/#{@project.id}/members" if @project }"; |
| 4 | GitLab.GfmAutoComplete.Members.params.private_token = "#{current_user.private_token}"; | 4 | GitLab.GfmAutoComplete.Members.params.private_token = "#{current_user.private_token}"; |
| 5 | 5 | ||
| 6 | GitLab.GfmAutoComplete.Emoji.data = #{raw emoji_autocomplete_source}; | 6 | GitLab.GfmAutoComplete.Emoji.data = #{raw emoji_autocomplete_source}; |
doc/api/README.md
| @@ -15,7 +15,7 @@ API requests should be prefixed with `api` and the API version. The API version | @@ -15,7 +15,7 @@ API requests should be prefixed with `api` and the API version. The API version | ||
| 15 | Example of a valid API request: | 15 | Example of a valid API request: |
| 16 | 16 | ||
| 17 | ``` | 17 | ``` |
| 18 | -GET http://example.com/api/v2/projects?private_token=QVy1PB7sTxfy4pqfZM1U | 18 | +GET http://example.com/api/v3/projects?private_token=QVy1PB7sTxfy4pqfZM1U |
| 19 | ``` | 19 | ``` |
| 20 | 20 | ||
| 21 | The API uses JSON to serialize data. You don't need to specify `.json` at the end of API URL. | 21 | The API uses JSON to serialize data. You don't need to specify `.json` at the end of API URL. |
doc/api/issues.md
| @@ -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
| @@ -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
| @@ -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
| @@ -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
| @@ -10,7 +10,6 @@ GET /projects | @@ -10,7 +10,6 @@ GET /projects | ||
| 10 | [ | 10 | [ |
| 11 | { | 11 | { |
| 12 | "id": 3, | 12 | "id": 3, |
| 13 | - "code": "rails", | ||
| 14 | "name": "rails", | 13 | "name": "rails", |
| 15 | "description": null, | 14 | "description": null, |
| 16 | "path": "rails", | 15 | "path": "rails", |
| @@ -32,7 +31,6 @@ GET /projects | @@ -32,7 +31,6 @@ GET /projects | ||
| 32 | }, | 31 | }, |
| 33 | { | 32 | { |
| 34 | "id": 5, | 33 | "id": 5, |
| 35 | - "code": "gitlab", | ||
| 36 | "name": "gitlab", | 34 | "name": "gitlab", |
| 37 | "description": null, | 35 | "description": null, |
| 38 | "path": "gitlab", | 36 | "path": "gitlab", |
| @@ -65,12 +63,11 @@ GET /projects/:id | @@ -65,12 +63,11 @@ GET /projects/:id | ||
| 65 | 63 | ||
| 66 | Parameters: | 64 | Parameters: |
| 67 | 65 | ||
| 68 | -+ `id` (required) - The ID or code name of a project | 66 | ++ `id` (required) - The ID of a project |
| 69 | 67 | ||
| 70 | ```json | 68 | ```json |
| 71 | { | 69 | { |
| 72 | "id": 5, | 70 | "id": 5, |
| 73 | - "code": "gitlab", | ||
| 74 | "name": "gitlab", | 71 | "name": "gitlab", |
| 75 | "description": null, | 72 | "description": null, |
| 76 | "path": "gitlab", | 73 | "path": "gitlab", |
| @@ -103,7 +100,6 @@ POST /projects | @@ -103,7 +100,6 @@ POST /projects | ||
| 103 | Parameters: | 100 | Parameters: |
| 104 | 101 | ||
| 105 | + `name` (required) - new project name | 102 | + `name` (required) - new project name |
| 106 | -+ `code` (optional) - new project code, uses project name if not set | ||
| 107 | + `path` (optional) - new project path, uses project name if not set | 103 | + `path` (optional) - new project path, uses project name if not set |
| 108 | + `description` (optional) - short project description | 104 | + `description` (optional) - short project description |
| 109 | + `default_branch` (optional) - 'master' by default | 105 | + `default_branch` (optional) - 'master' by default |
| @@ -125,7 +121,7 @@ GET /projects/:id/members | @@ -125,7 +121,7 @@ GET /projects/:id/members | ||
| 125 | 121 | ||
| 126 | Parameters: | 122 | Parameters: |
| 127 | 123 | ||
| 128 | -+ `id` (required) - The ID or code name of a project | 124 | ++ `id` (required) - The ID of a project |
| 129 | + `query` - Query string | 125 | + `query` - Query string |
| 130 | 126 | ||
| 131 | ## Get project team member | 127 | ## Get project team member |
| @@ -138,7 +134,7 @@ GET /projects/:id/members/:user_id | @@ -138,7 +134,7 @@ GET /projects/:id/members/:user_id | ||
| 138 | 134 | ||
| 139 | Parameters: | 135 | Parameters: |
| 140 | 136 | ||
| 141 | -+ `id` (required) - The ID or code name of a project | 137 | ++ `id` (required) - The ID of a project |
| 142 | + `user_id` (required) - The ID of a user | 138 | + `user_id` (required) - The ID of a user |
| 143 | 139 | ||
| 144 | ```json | 140 | ```json |
| @@ -164,7 +160,7 @@ POST /projects/:id/members | @@ -164,7 +160,7 @@ POST /projects/:id/members | ||
| 164 | 160 | ||
| 165 | Parameters: | 161 | Parameters: |
| 166 | 162 | ||
| 167 | -+ `id` (required) - The ID or code name of a project | 163 | ++ `id` (required) - The ID of a project |
| 168 | + `user_id` (required) - The ID of a user to add | 164 | + `user_id` (required) - The ID of a user to add |
| 169 | + `access_level` (required) - Project access level | 165 | + `access_level` (required) - Project access level |
| 170 | 166 | ||
| @@ -180,7 +176,7 @@ PUT /projects/:id/members/:user_id | @@ -180,7 +176,7 @@ PUT /projects/:id/members/:user_id | ||
| 180 | 176 | ||
| 181 | Parameters: | 177 | Parameters: |
| 182 | 178 | ||
| 183 | -+ `id` (required) - The ID or code name of a project | 179 | ++ `id` (required) - The ID of a project |
| 184 | + `user_id` (required) - The ID of a team member | 180 | + `user_id` (required) - The ID of a team member |
| 185 | + `access_level` (required) - Project access level | 181 | + `access_level` (required) - Project access level |
| 186 | 182 | ||
| @@ -196,7 +192,7 @@ DELETE /projects/:id/members/:user_id | @@ -196,7 +192,7 @@ DELETE /projects/:id/members/:user_id | ||
| 196 | 192 | ||
| 197 | Parameters: | 193 | Parameters: |
| 198 | 194 | ||
| 199 | -+ `id` (required) - The ID or code name of a project | 195 | ++ `id` (required) - The ID of a project |
| 200 | + `user_id` (required) - The ID of a team member | 196 | + `user_id` (required) - The ID of a team member |
| 201 | 197 | ||
| 202 | Status code `200` will be returned on success. | 198 | Status code `200` will be returned on success. |
| @@ -211,7 +207,7 @@ GET /projects/:id/hooks | @@ -211,7 +207,7 @@ GET /projects/:id/hooks | ||
| 211 | 207 | ||
| 212 | Parameters: | 208 | Parameters: |
| 213 | 209 | ||
| 214 | -+ `id` (required) - The ID or code name of a project | 210 | ++ `id` (required) - The ID of a project |
| 215 | 211 | ||
| 216 | 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. |
| 217 | 213 | ||
| @@ -225,7 +221,7 @@ GET /projects/:id/hooks/:hook_id | @@ -225,7 +221,7 @@ GET /projects/:id/hooks/:hook_id | ||
| 225 | 221 | ||
| 226 | Parameters: | 222 | Parameters: |
| 227 | 223 | ||
| 228 | -+ `id` (required) - The ID or code name of a project | 224 | ++ `id` (required) - The ID of a project |
| 229 | + `hook_id` (required) - The ID of a project hook | 225 | + `hook_id` (required) - The ID of a project hook |
| 230 | 226 | ||
| 231 | 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. |
| @@ -240,7 +236,7 @@ POST /projects/:id/hooks | @@ -240,7 +236,7 @@ POST /projects/:id/hooks | ||
| 240 | 236 | ||
| 241 | Parameters: | 237 | Parameters: |
| 242 | 238 | ||
| 243 | -+ `id` (required) - The ID or code name of a project | 239 | ++ `id` (required) - The ID of a project |
| 244 | + `url` (required) - The hook URL | 240 | + `url` (required) - The hook URL |
| 245 | 241 | ||
| 246 | 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. |
| @@ -255,7 +251,7 @@ PUT /projects/:id/hooks/:hook_id | @@ -255,7 +251,7 @@ PUT /projects/:id/hooks/:hook_id | ||
| 255 | 251 | ||
| 256 | Parameters: | 252 | Parameters: |
| 257 | 253 | ||
| 258 | -+ `id` (required) - The ID or code name of a project | 254 | ++ `id` (required) - The ID of a project |
| 259 | + `hook_id` (required) - The ID of a project hook | 255 | + `hook_id` (required) - The ID of a project hook |
| 260 | + `url` (required) - The hook URL | 256 | + `url` (required) - The hook URL |
| 261 | 257 | ||
| @@ -272,7 +268,7 @@ DELETE /projects/:id/hooks | @@ -272,7 +268,7 @@ DELETE /projects/:id/hooks | ||
| 272 | 268 | ||
| 273 | Parameters: | 269 | Parameters: |
| 274 | 270 | ||
| 275 | -+ `id` (required) - The ID or code name of a project | 271 | ++ `id` (required) - The ID of a project |
| 276 | + `hook_id` (required) - The ID of hook to delete | 272 | + `hook_id` (required) - The ID of hook to delete |
| 277 | 273 | ||
| 278 | 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
| @@ -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
| @@ -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.rb
| @@ -2,7 +2,7 @@ Dir["#{Rails.root}/lib/api/*.rb"].each {|file| require file} | @@ -2,7 +2,7 @@ Dir["#{Rails.root}/lib/api/*.rb"].each {|file| require file} | ||
| 2 | 2 | ||
| 3 | module Gitlab | 3 | module Gitlab |
| 4 | class API < Grape::API | 4 | class API < Grape::API |
| 5 | - version 'v2', using: :path | 5 | + version 'v3', using: :path |
| 6 | 6 | ||
| 7 | rescue_from ActiveRecord::RecordNotFound do | 7 | rescue_from ActiveRecord::RecordNotFound do |
| 8 | rack_response({'message' => '404 Not found'}.to_json, 404) | 8 | rack_response({'message' => '404 Not found'}.to_json, 404) |
lib/api/entities.rb
| @@ -18,7 +18,7 @@ module Gitlab | @@ -18,7 +18,7 @@ module Gitlab | ||
| 18 | end | 18 | end |
| 19 | 19 | ||
| 20 | class Project < Grape::Entity | 20 | class Project < Grape::Entity |
| 21 | - expose :id, :code, :name, :description, :path, :default_branch | 21 | + expose :id, :name, :description, :path, :default_branch |
| 22 | expose :owner, using: Entities::UserBasic | 22 | expose :owner, using: Entities::UserBasic |
| 23 | expose :private_flag, as: :private | 23 | expose :private_flag, as: :private |
| 24 | expose :issues_enabled, :merge_requests_enabled, :wall_enabled, :wiki_enabled, :created_at | 24 | expose :issues_enabled, :merge_requests_enabled, :wall_enabled, :wiki_enabled, :created_at |
lib/api/issues.rb
| @@ -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
| @@ -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
| @@ -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
| @@ -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
| @@ -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 |
| @@ -27,7 +27,6 @@ module Gitlab | @@ -27,7 +27,6 @@ module Gitlab | ||
| 27 | # | 27 | # |
| 28 | # Parameters: | 28 | # Parameters: |
| 29 | # name (required) - name for new project | 29 | # name (required) - name for new project |
| 30 | - # code (optional) - code for new project, uses project name if not set | ||
| 31 | # path (optional) - path for new project, uses project name if not set | 30 | # path (optional) - path for new project, uses project name if not set |
| 32 | # description (optional) - short project description | 31 | # description (optional) - short project description |
| 33 | # default_branch (optional) - 'master' by default | 32 | # default_branch (optional) - 'master' by default |
| @@ -56,7 +55,7 @@ module Gitlab | @@ -56,7 +55,7 @@ module Gitlab | ||
| 56 | # Get a project team members | 55 | # Get a project team members |
| 57 | # | 56 | # |
| 58 | # Parameters: | 57 | # Parameters: |
| 59 | - # id (required) - The ID or code name of a project | 58 | + # id (required) - The ID of a project |
| 60 | # query - Query string | 59 | # query - Query string |
| 61 | # Example Request: | 60 | # Example Request: |
| 62 | # GET /projects/:id/members | 61 | # GET /projects/:id/members |
| @@ -72,7 +71,7 @@ module Gitlab | @@ -72,7 +71,7 @@ module Gitlab | ||
| 72 | # Get a project team members | 71 | # Get a project team members |
| 73 | # | 72 | # |
| 74 | # Parameters: | 73 | # Parameters: |
| 75 | - # id (required) - The ID or code name of a project | 74 | + # id (required) - The ID of a project |
| 76 | # user_id (required) - The ID of a user | 75 | # user_id (required) - The ID of a user |
| 77 | # Example Request: | 76 | # Example Request: |
| 78 | # GET /projects/:id/members/:user_id | 77 | # GET /projects/:id/members/:user_id |
| @@ -84,7 +83,7 @@ module Gitlab | @@ -84,7 +83,7 @@ module Gitlab | ||
| 84 | # Add a new project team member | 83 | # Add a new project team member |
| 85 | # | 84 | # |
| 86 | # Parameters: | 85 | # Parameters: |
| 87 | - # id (required) - The ID or code name of a project | 86 | + # id (required) - The ID of a project |
| 88 | # user_id (required) - The ID of a user | 87 | # user_id (required) - The ID of a user |
| 89 | # access_level (required) - Project access level | 88 | # access_level (required) - Project access level |
| 90 | # Example Request: | 89 | # Example Request: |
| @@ -107,7 +106,7 @@ module Gitlab | @@ -107,7 +106,7 @@ module Gitlab | ||
| 107 | # Update project team member | 106 | # Update project team member |
| 108 | # | 107 | # |
| 109 | # Parameters: | 108 | # Parameters: |
| 110 | - # id (required) - The ID or code name of a project | 109 | + # id (required) - The ID of a project |
| 111 | # user_id (required) - The ID of a team member | 110 | # user_id (required) - The ID of a team member |
| 112 | # access_level (required) - Project access level | 111 | # access_level (required) - Project access level |
| 113 | # Example Request: | 112 | # Example Request: |
| @@ -127,7 +126,7 @@ module Gitlab | @@ -127,7 +126,7 @@ module Gitlab | ||
| 127 | # Remove a team member from project | 126 | # Remove a team member from project |
| 128 | # | 127 | # |
| 129 | # Parameters: | 128 | # Parameters: |
| 130 | - # id (required) - The ID or code name of a project | 129 | + # id (required) - The ID of a project |
| 131 | # user_id (required) - The ID of a team member | 130 | # user_id (required) - The ID of a team member |
| 132 | # Example Request: | 131 | # Example Request: |
| 133 | # DELETE /projects/:id/members/:user_id | 132 | # DELETE /projects/:id/members/:user_id |
| @@ -140,7 +139,7 @@ module Gitlab | @@ -140,7 +139,7 @@ module Gitlab | ||
| 140 | # Get project hooks | 139 | # Get project hooks |
| 141 | # | 140 | # |
| 142 | # Parameters: | 141 | # Parameters: |
| 143 | - # id (required) - The ID or code name of a project | 142 | + # id (required) - The ID of a project |
| 144 | # Example Request: | 143 | # Example Request: |
| 145 | # GET /projects/:id/hooks | 144 | # GET /projects/:id/hooks |
| 146 | get ":id/hooks" do | 145 | get ":id/hooks" do |
| @@ -152,7 +151,7 @@ module Gitlab | @@ -152,7 +151,7 @@ module Gitlab | ||
| 152 | # Get a project hook | 151 | # Get a project hook |
| 153 | # | 152 | # |
| 154 | # Parameters: | 153 | # Parameters: |
| 155 | - # id (required) - The ID or code name of a project | 154 | + # id (required) - The ID of a project |
| 156 | # hook_id (required) - The ID of a project hook | 155 | # hook_id (required) - The ID of a project hook |
| 157 | # Example Request: | 156 | # Example Request: |
| 158 | # GET /projects/:id/hooks/:hook_id | 157 | # GET /projects/:id/hooks/:hook_id |
| @@ -165,7 +164,7 @@ module Gitlab | @@ -165,7 +164,7 @@ module Gitlab | ||
| 165 | # Add hook to project | 164 | # Add hook to project |
| 166 | # | 165 | # |
| 167 | # Parameters: | 166 | # Parameters: |
| 168 | - # id (required) - The ID or code name of a project | 167 | + # id (required) - The ID of a project |
| 169 | # url (required) - The hook URL | 168 | # url (required) - The hook URL |
| 170 | # Example Request: | 169 | # Example Request: |
| 171 | # POST /projects/:id/hooks | 170 | # POST /projects/:id/hooks |
| @@ -182,7 +181,7 @@ module Gitlab | @@ -182,7 +181,7 @@ module Gitlab | ||
| 182 | # Update an existing project hook | 181 | # Update an existing project hook |
| 183 | # | 182 | # |
| 184 | # Parameters: | 183 | # Parameters: |
| 185 | - # id (required) - The ID or code name of a project | 184 | + # id (required) - The ID of a project |
| 186 | # hook_id (required) - The ID of a project hook | 185 | # hook_id (required) - The ID of a project hook |
| 187 | # url (required) - The hook URL | 186 | # url (required) - The hook URL |
| 188 | # Example Request: | 187 | # Example Request: |
| @@ -203,7 +202,7 @@ module Gitlab | @@ -203,7 +202,7 @@ module Gitlab | ||
| 203 | # Delete project hook | 202 | # Delete project hook |
| 204 | # | 203 | # |
| 205 | # Parameters: | 204 | # Parameters: |
| 206 | - # id (required) - The ID or code name of a project | 205 | + # id (required) - The ID of a project |
| 207 | # hook_id (required) - The ID of hook to delete | 206 | # hook_id (required) - The ID of hook to delete |
| 208 | # Example Request: | 207 | # Example Request: |
| 209 | # DELETE /projects/:id/hooks | 208 | # DELETE /projects/:id/hooks |
| @@ -216,7 +215,7 @@ module Gitlab | @@ -216,7 +215,7 @@ module Gitlab | ||
| 216 | # Get a project repository branches | 215 | # Get a project repository branches |
| 217 | # | 216 | # |
| 218 | # Parameters: | 217 | # Parameters: |
| 219 | - # id (required) - The ID or code name of a project | 218 | + # id (required) - The ID of a project |
| 220 | # Example Request: | 219 | # Example Request: |
| 221 | # GET /projects/:id/repository/branches | 220 | # GET /projects/:id/repository/branches |
| 222 | get ":id/repository/branches" do | 221 | get ":id/repository/branches" do |
| @@ -226,7 +225,7 @@ module Gitlab | @@ -226,7 +225,7 @@ module Gitlab | ||
| 226 | # Get a single branch | 225 | # Get a single branch |
| 227 | # | 226 | # |
| 228 | # Parameters: | 227 | # Parameters: |
| 229 | - # id (required) - The ID or code name of a project | 228 | + # id (required) - The ID of a project |
| 230 | # branch (required) - The name of the branch | 229 | # branch (required) - The name of the branch |
| 231 | # Example Request: | 230 | # Example Request: |
| 232 | # GET /projects/:id/repository/branches/:branch | 231 | # GET /projects/:id/repository/branches/:branch |
| @@ -238,7 +237,7 @@ module Gitlab | @@ -238,7 +237,7 @@ module Gitlab | ||
| 238 | # Get a project repository tags | 237 | # Get a project repository tags |
| 239 | # | 238 | # |
| 240 | # Parameters: | 239 | # Parameters: |
| 241 | - # id (required) - The ID or code name of a project | 240 | + # id (required) - The ID of a project |
| 242 | # Example Request: | 241 | # Example Request: |
| 243 | # GET /projects/:id/repository/tags | 242 | # GET /projects/:id/repository/tags |
| 244 | get ":id/repository/tags" do | 243 | get ":id/repository/tags" do |
| @@ -248,7 +247,7 @@ module Gitlab | @@ -248,7 +247,7 @@ module Gitlab | ||
| 248 | # Get a project repository commits | 247 | # Get a project repository commits |
| 249 | # | 248 | # |
| 250 | # Parameters: | 249 | # Parameters: |
| 251 | - # id (required) - The ID or code name of a project | 250 | + # id (required) - The ID of a project |
| 252 | # ref_name (optional) - The name of a repository branch or tag | 251 | # ref_name (optional) - The name of a repository branch or tag |
| 253 | # Example Request: | 252 | # Example Request: |
| 254 | # GET /projects/:id/repository/commits | 253 | # GET /projects/:id/repository/commits |
| @@ -266,7 +265,7 @@ module Gitlab | @@ -266,7 +265,7 @@ module Gitlab | ||
| 266 | # Get a project snippets | 265 | # Get a project snippets |
| 267 | # | 266 | # |
| 268 | # Parameters: | 267 | # Parameters: |
| 269 | - # id (required) - The ID or code name of a project | 268 | + # id (required) - The ID of a project |
| 270 | # Example Request: | 269 | # Example Request: |
| 271 | # GET /projects/:id/snippets | 270 | # GET /projects/:id/snippets |
| 272 | get ":id/snippets" do | 271 | get ":id/snippets" do |
| @@ -276,7 +275,7 @@ module Gitlab | @@ -276,7 +275,7 @@ module Gitlab | ||
| 276 | # Get a project snippet | 275 | # Get a project snippet |
| 277 | # | 276 | # |
| 278 | # Parameters: | 277 | # Parameters: |
| 279 | - # id (required) - The ID or code name of a project | 278 | + # id (required) - The ID of a project |
| 280 | # snippet_id (required) - The ID of a project snippet | 279 | # snippet_id (required) - The ID of a project snippet |
| 281 | # Example Request: | 280 | # Example Request: |
| 282 | # GET /projects/:id/snippets/:snippet_id | 281 | # GET /projects/:id/snippets/:snippet_id |
| @@ -288,7 +287,7 @@ module Gitlab | @@ -288,7 +287,7 @@ module Gitlab | ||
| 288 | # Create a new project snippet | 287 | # Create a new project snippet |
| 289 | # | 288 | # |
| 290 | # Parameters: | 289 | # Parameters: |
| 291 | - # id (required) - The ID or code name of a project | 290 | + # id (required) - The ID of a project |
| 292 | # title (required) - The title of a snippet | 291 | # title (required) - The title of a snippet |
| 293 | # file_name (required) - The name of a snippet file | 292 | # file_name (required) - The name of a snippet file |
| 294 | # lifetime (optional) - The expiration date of a snippet | 293 | # lifetime (optional) - The expiration date of a snippet |
| @@ -314,7 +313,7 @@ module Gitlab | @@ -314,7 +313,7 @@ module Gitlab | ||
| 314 | # Update an existing project snippet | 313 | # Update an existing project snippet |
| 315 | # | 314 | # |
| 316 | # Parameters: | 315 | # Parameters: |
| 317 | - # id (required) - The ID or code name of a project | 316 | + # id (required) - The ID of a project |
| 318 | # snippet_id (required) - The ID of a project snippet | 317 | # snippet_id (required) - The ID of a project snippet |
| 319 | # title (optional) - The title of a snippet | 318 | # title (optional) - The title of a snippet |
| 320 | # file_name (optional) - The name of a snippet file | 319 | # file_name (optional) - The name of a snippet file |
| @@ -340,7 +339,7 @@ module Gitlab | @@ -340,7 +339,7 @@ module Gitlab | ||
| 340 | # Delete a project snippet | 339 | # Delete a project snippet |
| 341 | # | 340 | # |
| 342 | # Parameters: | 341 | # Parameters: |
| 343 | - # id (required) - The ID or code name of a project | 342 | + # id (required) - The ID of a project |
| 344 | # snippet_id (required) - The ID of a project snippet | 343 | # snippet_id (required) - The ID of a project snippet |
| 345 | # Example Request: | 344 | # Example Request: |
| 346 | # DELETE /projects/:id/snippets/:snippet_id | 345 | # DELETE /projects/:id/snippets/:snippet_id |
| @@ -354,7 +353,7 @@ module Gitlab | @@ -354,7 +353,7 @@ module Gitlab | ||
| 354 | # Get a raw project snippet | 353 | # Get a raw project snippet |
| 355 | # | 354 | # |
| 356 | # Parameters: | 355 | # Parameters: |
| 357 | - # id (required) - The ID or code name of a project | 356 | + # id (required) - The ID of a project |
| 358 | # snippet_id (required) - The ID of a project snippet | 357 | # snippet_id (required) - The ID of a project snippet |
| 359 | # Example Request: | 358 | # Example Request: |
| 360 | # GET /projects/:id/snippets/:snippet_id/raw | 359 | # GET /projects/:id/snippets/:snippet_id/raw |
| @@ -367,7 +366,7 @@ module Gitlab | @@ -367,7 +366,7 @@ module Gitlab | ||
| 367 | # Get a raw file contents | 366 | # Get a raw file contents |
| 368 | # | 367 | # |
| 369 | # Parameters: | 368 | # Parameters: |
| 370 | - # id (required) - The ID or code name of a project | 369 | + # id (required) - The ID of a project |
| 371 | # sha (required) - The commit or branch name | 370 | # sha (required) - The commit or branch name |
| 372 | # filepath (required) - The path to the file to display | 371 | # filepath (required) - The path to the file to display |
| 373 | # Example Request: | 372 | # Example Request: |