Skip to content
Snippets Groups Projects
Commit 8f01190e authored by Riyad Preukschas's avatar Riyad Preukschas
Browse files

Remove all references tp the project code parameter from the API

parent 931ec399
No related branches found
No related tags found
1 merge request!2330V4.0 API fixes
Hide whitespace changes
Inline Side-by-side
Showing
with 86 additions and 86 deletions
doc/api/issues.md
+ 4
− 4
View file @ 8f01190e
@@ -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
doc/api/merge_requests.md
+ 5
− 5
View file @ 8f01190e
@@ -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
 
doc/api/milestones.md
+ 4
− 4
View file @ 8f01190e
@@ -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
doc/api/notes.md
+ 9
− 9
View file @ 8f01190e
@@ -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
 
doc/api/projects.md
+ 11
− 11
View file @ 8f01190e
@@ -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.
doc/api/repositories.md
+ 5
− 5
View file @ 8f01190e
@@ -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
 
doc/api/snippets.md
+ 6
− 6
View file @ 8f01190e
@@ -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.
lib/api/issues.rb
+ 5
− 5
View file @ 8f01190e
@@ -17,7 +17,7 @@ module Gitlab
# Get a list of project issues
#
# Parameters:
# id (required) - The ID or code name of a project
# id (required) - The ID of a project
# Example Request:
# GET /projects/:id/issues
get ":id/issues" do
@@ -27,7 +27,7 @@ module Gitlab
# Get a single project issue
#
# 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
# Example Request:
# GET /projects/:id/issues/:issue_id
@@ -39,7 +39,7 @@ module Gitlab
# Create a new project issue
#
# 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
@@ -62,7 +62,7 @@ module Gitlab
# Update an existing issue
#
# 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
# title (optional) - The title of an issue
# description (optional) - The description of an issue
@@ -88,7 +88,7 @@ module Gitlab
# Delete a project issue (deprecated)
#
# 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
# Example Request:
# DELETE /projects/:id/issues/:issue_id
lib/api/merge_requests.rb
+ 5
− 5
View file @ 8f01190e
@@ -8,7 +8,7 @@ module Gitlab
# List merge requests
#
# Parameters:
# id (required) - The ID or code name of a project
# id (required) - The ID of a project
#
# Example:
# GET /projects/:id/merge_requests
@@ -22,7 +22,7 @@ module Gitlab
# Show MR
#
# 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
#
# Example:
@@ -40,7 +40,7 @@ module Gitlab
#
# 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
@@ -67,7 +67,7 @@ module Gitlab
# Update MR
#
# 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
@@ -95,7 +95,7 @@ module Gitlab
# Post comment to merge request
#
# 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
# Examples:
lib/api/milestones.rb
+ 4
− 4
View file @ 8f01190e
@@ -7,7 +7,7 @@ module Gitlab
# Get a list of project milestones
#
# Parameters:
# id (required) - The ID or code name of a project
# id (required) - The ID of a project
# Example Request:
# GET /projects/:id/milestones
get ":id/milestones" do
@@ -19,7 +19,7 @@ module Gitlab
# Get a single project milestone
#
# 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
# Example Request:
# GET /projects/:id/milestones/:milestone_id
@@ -33,7 +33,7 @@ module Gitlab
# Create a new project milestone
#
# Parameters:
# id (required) - The ID or code name of the project
# id (required) - The ID of the project
# title (required) - The title of the milestone
# description (optional) - The description of the milestone
# due_date (optional) - The due date of the milestone
@@ -54,7 +54,7 @@ module Gitlab
# Update an existing project milestone
#
# 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
lib/api/notes.rb
+ 6
− 6
View file @ 8f01190e
@@ -9,7 +9,7 @@ module Gitlab
# Get a list of project wall notes
#
# Parameters:
# id (required) - The ID or code name of a project
# id (required) - The ID of a project
# Example Request:
# GET /projects/:id/notes
get ":id/notes" do
@@ -20,7 +20,7 @@ module Gitlab
# Get a single project wall note
#
# 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 note
# Example Request:
# GET /projects/:id/notes/:note_id
@@ -32,7 +32,7 @@ module Gitlab
# Create a new project wall note
#
# 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
# Example Request:
# POST /projects/:id/notes
@@ -54,7 +54,7 @@ module Gitlab
# Get a list of project +noteable+ notes
#
# Parameters:
# id (required) - The ID or code name of a project
# id (required) - The ID of a project
# noteable_id (required) - The ID of an issue or snippet
# Example Request:
# GET /projects/:id/issues/:noteable_id/notes
@@ -67,7 +67,7 @@ module Gitlab
# Get a single +noteable+ note
#
# Parameters:
# id (required) - The ID or code name of a project
# id (required) - The ID of a project
# noteable_id (required) - The ID of an issue or snippet
# note_id (required) - The ID of a note
# Example Request:
@@ -82,7 +82,7 @@ module Gitlab
# Create a new +noteable+ note
#
# Parameters:
# id (required) - The ID or code name of a project
# id (required) - The ID of a project
# noteable_id (required) - The ID of an issue or snippet
# body (required) - The content of a note
# Example Request:
lib/api/projects.rb
+ 22
− 22
View file @ 8f01190e
@@ -16,7 +16,7 @@ module Gitlab
# Get a single project
#
# Parameters:
# id (required) - The ID or code name of a project
# id (required) - The ID of a project
# Example Request:
# GET /projects/:id
get ":id" do
@@ -55,7 +55,7 @@ module Gitlab
# Get a project team members
#
# Parameters:
# id (required) - The ID or code name of a project
# id (required) - The ID of a project
# query - Query string
# Example Request:
# GET /projects/:id/members
@@ -71,7 +71,7 @@ module Gitlab
# Get a project team 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
# Example Request:
# GET /projects/:id/members/:user_id
@@ -83,7 +83,7 @@ module Gitlab
# Add a new project team member
#
# 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
# access_level (required) - Project access level
# Example Request:
@@ -106,7 +106,7 @@ module Gitlab
# Update project team member
#
# 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
# Example Request:
@@ -126,7 +126,7 @@ module Gitlab
# Remove a team member from project
#
# 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
# Example Request:
# DELETE /projects/:id/members/:user_id
@@ -139,7 +139,7 @@ module Gitlab
# Get project hooks
#
# Parameters:
# id (required) - The ID or code name of a project
# id (required) - The ID of a project
# Example Request:
# GET /projects/:id/hooks
get ":id/hooks" do
@@ -151,7 +151,7 @@ module Gitlab
# Get a project hook
#
# 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
# Example Request:
# GET /projects/:id/hooks/:hook_id
@@ -164,7 +164,7 @@ module Gitlab
# Add hook to project
#
# Parameters:
# id (required) - The ID or code name of a project
# id (required) - The ID of a project
# url (required) - The hook URL
# Example Request:
# POST /projects/:id/hooks
@@ -181,7 +181,7 @@ module Gitlab
# Update an existing project hook
#
# 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
# Example Request:
@@ -202,7 +202,7 @@ module Gitlab
# Delete project hook
#
# 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
# Example Request:
# DELETE /projects/:id/hooks
@@ -215,7 +215,7 @@ module Gitlab
# Get a project repository branches
#
# Parameters:
# id (required) - The ID or code name of a project
# id (required) - The ID of a project
# Example Request:
# GET /projects/:id/repository/branches
get ":id/repository/branches" do
@@ -225,7 +225,7 @@ module Gitlab
# Get a single 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
# Example Request:
# GET /projects/:id/repository/branches/:branch
@@ -237,7 +237,7 @@ module Gitlab
# Get a project repository tags
#
# Parameters:
# id (required) - The ID or code name of a project
# id (required) - The ID of a project
# Example Request:
# GET /projects/:id/repository/tags
get ":id/repository/tags" do
@@ -247,7 +247,7 @@ module Gitlab
# Get a project 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
# Example Request:
# GET /projects/:id/repository/commits
@@ -265,7 +265,7 @@ module Gitlab
# Get a project snippets
#
# Parameters:
# id (required) - The ID or code name of a project
# id (required) - The ID of a project
# Example Request:
# GET /projects/:id/snippets
get ":id/snippets" do
@@ -275,7 +275,7 @@ module Gitlab
# Get a project snippet
#
# 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
# Example Request:
# GET /projects/:id/snippets/:snippet_id
@@ -287,7 +287,7 @@ module Gitlab
# Create a new project snippet
#
# 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
@@ -313,7 +313,7 @@ module Gitlab
# Update an existing project snippet
#
# 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
# title (optional) - The title of a snippet
# file_name (optional) - The name of a snippet file
@@ -339,7 +339,7 @@ module Gitlab
# Delete a project snippet
#
# 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
# Example Request:
# DELETE /projects/:id/snippets/:snippet_id
@@ -353,7 +353,7 @@ module Gitlab
# Get a raw project snippet
#
# 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
# Example Request:
# GET /projects/:id/snippets/:snippet_id/raw
@@ -366,7 +366,7 @@ module Gitlab
# Get a raw file contents
#
# 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 to the file to display
# Example Request:
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment