diff options
author | Riyad Preukschas <riyad@informatik.uni-bremen.de> | 2012-12-21 18:47:04 +0100 |
---|---|---|
committer | Riyad Preukschas <riyad@informatik.uni-bremen.de> | 2012-12-21 18:47:04 +0100 |
commit | 8f01190eb5ec0f40d6f8874a3f3c79637000a709 (patch) | |
tree | 3db8cdf1455059c8274edaf89573550ecf166e88 /doc | |
parent | 931ec399bd16321f5bdd8e745f2f87dfe25a83ac (diff) | |
download | gitlab-ce-8f01190eb5ec0f40d6f8874a3f3c79637000a709.tar.gz |
Remove all references tp the project code parameter from the API
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/issues.md | 8 | ||||
-rw-r--r-- | doc/api/merge_requests.md | 10 | ||||
-rw-r--r-- | doc/api/milestones.md | 8 | ||||
-rw-r--r-- | doc/api/notes.md | 18 | ||||
-rw-r--r-- | doc/api/projects.md | 22 | ||||
-rw-r--r-- | doc/api/repositories.md | 10 | ||||
-rw-r--r-- | doc/api/snippets.md | 12 |
7 files changed, 44 insertions, 44 deletions
diff --git a/doc/api/issues.md b/doc/api/issues.md index b5b5a4eadd4..0383b676073 100644 --- a/doc/api/issues.md +++ b/doc/api/issues.md @@ -78,7 +78,7 @@ GET /projects/:id/issues Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project ## Single issue @@ -90,7 +90,7 @@ GET /projects/:id/issues/:issue_id Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `issue_id` (required) - The ID of a project issue ```json @@ -143,7 +143,7 @@ POST /projects/:id/issues Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `title` (required) - The title of an issue + `description` (optional) - The description of an issue + `assignee_id` (optional) - The ID of a user to assign issue @@ -162,7 +162,7 @@ PUT /projects/:id/issues/:issue_id Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `issue_id` (required) - The ID of a project's issue + `title` (optional) - The title of an issue + `description` (optional) - The description of an issue diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md index 86bd79ff43a..525c55d12c2 100644 --- a/doc/api/merge_requests.md +++ b/doc/api/merge_requests.md @@ -8,7 +8,7 @@ GET /projects/:id/merge_requests Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project ```json [ @@ -50,7 +50,7 @@ GET /projects/:id/merge_request/:merge_request_id Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `merge_request_id` (required) - The ID of MR ```json @@ -92,7 +92,7 @@ POST /projects/:id/merge_requests Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `source_branch` (required) - The source branch + `target_branch` (required) - The target branch + `assignee_id` - Assignee user ID @@ -136,7 +136,7 @@ PUT /projects/:id/merge_request/:merge_request_id Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `merge_request_id` (required) - ID of MR + `source_branch` - The source branch + `target_branch` - The target branch @@ -182,7 +182,7 @@ POST /projects/:id/merge_request/:merge_request_id/comments Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `merge_request_id` (required) - ID of MR + `note` (required) - Text of comment diff --git a/doc/api/milestones.md b/doc/api/milestones.md index f68d8eb7d58..b997e83901b 100644 --- a/doc/api/milestones.md +++ b/doc/api/milestones.md @@ -8,7 +8,7 @@ GET /projects/:id/milestones Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project ## Single milestone @@ -20,7 +20,7 @@ GET /projects/:id/milestones/:milestone_id Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `milestone_id` (required) - The ID of a project milestone ## New milestone @@ -33,7 +33,7 @@ POST /projects/:id/milestones Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `milestone_id` (required) - The ID of a project milestone + `title` (required) - The title of an milestone + `description` (optional) - The description of the milestone @@ -49,7 +49,7 @@ PUT /projects/:id/milestones/:milestone_id Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `milestone_id` (required) - The ID of a project milestone + `title` (optional) - The title of a milestone + `description` (optional) - The description of a milestone diff --git a/doc/api/notes.md b/doc/api/notes.md index dddb55edb93..bb33efb8c25 100644 --- a/doc/api/notes.md +++ b/doc/api/notes.md @@ -28,7 +28,7 @@ GET /projects/:id/notes Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project ### List issue notes @@ -40,7 +40,7 @@ GET /projects/:id/issues/:issue_id/notes Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `issue_id` (required) - The ID of an issue ### List snippet notes @@ -53,7 +53,7 @@ GET /projects/:id/snippets/:snippet_id/notes Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `snippet_id` (required) - The ID of a snippet ## Single note @@ -68,7 +68,7 @@ GET /projects/:id/notes/:note_id Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `note_id` (required) - The ID of a wall note ### Single issue note @@ -81,7 +81,7 @@ GET /projects/:id/issues/:issue_id/:notes/:note_id Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `issue_id` (required) - The ID of a project issue + `note_id` (required) - The ID of an issue note @@ -95,7 +95,7 @@ GET /projects/:id/issues/:snippet_id/:notes/:note_id Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `snippet_id` (required) - The ID of a project snippet + `note_id` (required) - The ID of an snippet note @@ -111,7 +111,7 @@ POST /projects/:id/notes Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `body` (required) - The content of a note 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 Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `issue_id` (required) - The ID of an issue + `body` (required) - The content of a note @@ -143,7 +143,7 @@ POST /projects/:id/snippets/:snippet_id/notes Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `snippet_id` (required) - The ID of an snippet + `body` (required) - The content of a note diff --git a/doc/api/projects.md b/doc/api/projects.md index 42c20ff6e5f..b38e60ee296 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -63,7 +63,7 @@ GET /projects/:id Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project ```json { @@ -121,7 +121,7 @@ GET /projects/:id/members Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `query` - Query string ## Get project team member @@ -134,7 +134,7 @@ GET /projects/:id/members/:user_id Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `user_id` (required) - The ID of a user ```json @@ -160,7 +160,7 @@ POST /projects/:id/members Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `user_id` (required) - The ID of a user to add + `access_level` (required) - Project access level @@ -176,7 +176,7 @@ PUT /projects/:id/members/:user_id Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `user_id` (required) - The ID of a team member + `access_level` (required) - Project access level @@ -192,7 +192,7 @@ DELETE /projects/:id/members/:user_id Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `user_id` (required) - The ID of a team member Status code `200` will be returned on success. @@ -207,7 +207,7 @@ GET /projects/:id/hooks Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project Will return hooks with status `200 OK` on success, or `404 Not found` on fail. @@ -221,7 +221,7 @@ GET /projects/:id/hooks/:hook_id Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `hook_id` (required) - The ID of a project hook Will return hook with status `200 OK` on success, or `404 Not found` on fail. @@ -236,7 +236,7 @@ POST /projects/:id/hooks Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `url` (required) - The hook URL Will return status `201 Created` on success, or `404 Not found` on fail. @@ -251,7 +251,7 @@ PUT /projects/:id/hooks/:hook_id Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `hook_id` (required) - The ID of a project hook + `url` (required) - The hook URL @@ -268,7 +268,7 @@ DELETE /projects/:id/hooks Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `hook_id` (required) - The ID of hook to delete Will return status `200 OK` on success, or `404 Not found` on fail. diff --git a/doc/api/repositories.md b/doc/api/repositories.md index 487ad9b2718..685797ad78d 100644 --- a/doc/api/repositories.md +++ b/doc/api/repositories.md @@ -8,7 +8,7 @@ GET /projects/:id/repository/branches Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project ```json [ @@ -48,7 +48,7 @@ GET /projects/:id/repository/branches/:branch Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `branch` (required) - The name of the branch ```json @@ -87,7 +87,7 @@ GET /projects/:id/repository/tags Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project ```json [ @@ -125,7 +125,7 @@ GET /projects/:id/repository/commits Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `ref_name` (optional) - The name of a repository branch or tag ```json @@ -159,7 +159,7 @@ GET /projects/:id/repository/commits/:sha/blob Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `sha` (required) - The commit or branch name + `filepath` (required) - The path the file diff --git a/doc/api/snippets.md b/doc/api/snippets.md index b9638ea8291..ceb8a63d06f 100644 --- a/doc/api/snippets.md +++ b/doc/api/snippets.md @@ -8,7 +8,7 @@ GET /projects/:id/snippets Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project ## Single snippet @@ -20,7 +20,7 @@ GET /projects/:id/snippets/:snippet_id Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `snippet_id` (required) - The ID of a project's snippet ```json @@ -52,7 +52,7 @@ GET /projects/:id/snippets/:snippet_id/raw Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `snippet_id` (required) - The ID of a project's snippet ## New snippet @@ -65,7 +65,7 @@ POST /projects/:id/snippets Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `title` (required) - The title of a snippet + `file_name` (required) - The name of a snippet file + `lifetime` (optional) - The expiration date of a snippet @@ -83,7 +83,7 @@ PUT /projects/:id/snippets/:snippet_id Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `snippet_id` (required) - The ID of a project's snippet + `title` (optional) - The title of a snippet + `file_name` (optional) - The name of a snippet file @@ -102,7 +102,7 @@ DELETE /projects/:id/snippets/:snippet_id Parameters: -+ `id` (required) - The ID or code name of a project ++ `id` (required) - The ID of a project + `snippet_id` (required) - The ID of a project's snippet Status code `200` will be returned on success. |