summaryrefslogtreecommitdiff
path: root/lib/api
diff options
context:
space:
mode:
authorDmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>2012-12-22 00:43:17 -0800
committerDmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>2012-12-22 00:43:17 -0800
commit8fe58ed541e04f81de8e401c17d021aa4092a526 (patch)
tree01e4244fef95d9b2970378763340d73bbec58803 /lib/api
parent86673a66b7ff2eebe1d88311425586be5c79c0ca (diff)
parenteaa99478a7612405bc93941ea69b93e7e776ca56 (diff)
downloadgitlab-ce-8fe58ed541e04f81de8e401c17d021aa4092a526.tar.gz
Merge pull request #2330 from gitlabhq/v4.0-api-fixes
V4.0 API fixes
Diffstat (limited to 'lib/api')
-rw-r--r--lib/api/entities.rb2
-rw-r--r--lib/api/issues.rb10
-rw-r--r--lib/api/merge_requests.rb10
-rw-r--r--lib/api/milestones.rb8
-rw-r--r--lib/api/notes.rb12
-rw-r--r--lib/api/projects.rb45
6 files changed, 43 insertions, 44 deletions
diff --git a/lib/api/entities.rb b/lib/api/entities.rb
index 070fbad27ed..92245a9f093 100644
--- a/lib/api/entities.rb
+++ b/lib/api/entities.rb
@@ -18,7 +18,7 @@ module Gitlab
end
class Project < Grape::Entity
- expose :id, :code, :name, :description, :path, :default_branch
+ expose :id, :name, :description, :path, :default_branch
expose :owner, using: Entities::UserBasic
expose :private_flag, as: :private
expose :issues_enabled, :merge_requests_enabled, :wall_enabled, :wiki_enabled, :created_at
diff --git a/lib/api/issues.rb b/lib/api/issues.rb
index 4ee2d11f15f..3be558816b5 100644
--- a/lib/api/issues.rb
+++ b/lib/api/issues.rb
@@ -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
diff --git a/lib/api/merge_requests.rb b/lib/api/merge_requests.rb
index 1fa0c549b13..470cd1e1c2d 100644
--- a/lib/api/merge_requests.rb
+++ b/lib/api/merge_requests.rb
@@ -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:
diff --git a/lib/api/milestones.rb b/lib/api/milestones.rb
index f55dfd04cc5..6aca9d01b09 100644
--- a/lib/api/milestones.rb
+++ b/lib/api/milestones.rb
@@ -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
diff --git a/lib/api/notes.rb b/lib/api/notes.rb
index a3e1858458d..4875ac4c03e 100644
--- a/lib/api/notes.rb
+++ b/lib/api/notes.rb
@@ -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:
diff --git a/lib/api/projects.rb b/lib/api/projects.rb
index 044a6272766..64b65f16b7e 100644
--- a/lib/api/projects.rb
+++ b/lib/api/projects.rb
@@ -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
@@ -27,7 +27,6 @@ module Gitlab
#
# Parameters:
# name (required) - name for new project
- # code (optional) - code for new project, uses project name if not set
# path (optional) - path for new project, uses project name if not set
# description (optional) - short project description
# default_branch (optional) - 'master' by default
@@ -56,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
@@ -72,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
@@ -84,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:
@@ -107,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:
@@ -127,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
@@ -140,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
@@ -152,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
@@ -165,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
@@ -182,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:
@@ -203,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
@@ -216,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
@@ -226,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
@@ -238,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
@@ -248,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
@@ -266,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
@@ -276,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
@@ -288,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
@@ -314,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
@@ -340,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
@@ -354,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
@@ -367,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: