Merge pull request #2330 from gitlabhq/v4.0-api-fixes

V4.0 API fixes

1 files changed, 22 insertions, 23 deletions

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: