summaryrefslogtreecommitdiff
path: root/lib/api
diff options
context:
space:
mode:
Diffstat (limited to 'lib/api')
-rw-r--r--lib/api/issues.rb10
-rw-r--r--lib/api/projects.rb16
2 files changed, 13 insertions, 13 deletions
diff --git a/lib/api/issues.rb b/lib/api/issues.rb
index 2b6a1ac269d..dcb6e53588c 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 code name of a project
+ # id (required) - The ID or code name 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 code name of a project
+ # id (required) - The ID or code name 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 code name of a project
+ # id (required) - The ID or code name 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
@@ -67,7 +67,7 @@ module Gitlab
# Update an existing issue
#
# Parameters:
- # id (required) - The code name of a project
+ # id (required) - The ID or code name 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
@@ -98,7 +98,7 @@ module Gitlab
# Delete a project issue
#
# Parameters:
- # id (required) - The code name of a project
+ # id (required) - The ID or code name 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/projects.rb b/lib/api/projects.rb
index 34d1c23676e..8edfa481c10 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 code of a project
+ # id (required) - The ID or code name of a project
# Example Request:
# GET /projects/:id
get ":id" do
@@ -26,7 +26,7 @@ module Gitlab
# Get a project repository branches
#
# Parameters:
- # id (required) - The code of a project
+ # id (required) - The ID or code name of a project
# Example Request:
# GET /projects/:id/repository/branches
get ":id/repository/branches" do
@@ -36,7 +36,7 @@ module Gitlab
# Get a project repository tags
#
# Parameters:
- # id (required) - The code of a project
+ # id (required) - The ID or code name of a project
# Example Request:
# GET /projects/:id/repository/tags
get ":id/repository/tags" do
@@ -46,7 +46,7 @@ module Gitlab
# Get a project snippet
#
# Parameters:
- # id (required) - The code of a project
+ # id (required) - The ID or code name of a project
# snippet_id (required) - The ID of a project snippet
# Example Request:
# GET /projects/:id/snippets/:snippet_id
@@ -58,7 +58,7 @@ module Gitlab
# Create a new project snippet
#
# Parameters:
- # id (required) - The code name of a project
+ # id (required) - The ID or code name 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
@@ -84,7 +84,7 @@ module Gitlab
# Update an existing project snippet
#
# Parameters:
- # id (required) - The code name of a project
+ # id (required) - The ID or code name 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
@@ -111,7 +111,7 @@ module Gitlab
# Delete a project snippet
#
# Parameters:
- # id (required) - The code of a project
+ # id (required) - The ID or code name of a project
# snippet_id (required) - The ID of a project snippet
# Example Request:
# DELETE /projects/:id/snippets/:snippet_id
@@ -123,7 +123,7 @@ module Gitlab
# Get a raw project snippet
#
# Parameters:
- # id (required) - The code of a project
+ # id (required) - The ID or code name of a project
# snippet_id (required) - The ID of a project snippet
# Example Request:
# GET /projects/:id/snippets/:snippet_id/raw