diff options
Diffstat (limited to 'doc/api/projects.md')
| -rw-r--r-- | doc/api/projects.md | 31 |
1 files changed, 16 insertions, 15 deletions
diff --git a/doc/api/projects.md b/doc/api/projects.md index 559553a1108..e795298c672 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -162,7 +162,7 @@ GET /projects/:id/events Parameters: -+ `id` (required) - The ID or NAME of a project ++ `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project ```json @@ -231,6 +231,7 @@ POST /projects Parameters: + `name` (required) - new project name ++ `namespace_id` (optional) - namespace for the new project (defaults to user) + `description` (optional) - short project description + `issues_enabled` (optional) + `wall_enabled` (optional) @@ -290,7 +291,7 @@ GET /projects/:id/members Parameters: -+ `id` (required) - The ID or NAME of a project ++ `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project + `query` (optional) - Query string to search for members @@ -304,7 +305,7 @@ GET /projects/:id/members/:user_id Parameters: -+ `id` (required) - The ID or NAME of a project ++ `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project + `user_id` (required) - The ID of a user ```json @@ -332,7 +333,7 @@ POST /projects/:id/members Parameters: -+ `id` (required) - The ID or NAME of a project ++ `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project + `user_id` (required) - The ID of a user to add + `access_level` (required) - Project access level @@ -347,7 +348,7 @@ PUT /projects/:id/members/:user_id Parameters: -+ `id` (required) - The ID or NAME of a project ++ `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project + `user_id` (required) - The ID of a team member + `access_level` (required) - Project access level @@ -362,7 +363,7 @@ DELETE /projects/:id/members/:user_id Parameters: -+ `id` (required) - The ID or NAME of a project ++ `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project + `user_id` (required) - The ID of a team member This method is idempotent and can be called multiple times with the same parameters. @@ -383,7 +384,7 @@ GET /projects/:id/hooks Parameters: -+ `id` (required) - The ID or NAME of a project ++ `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project ### Get project hook @@ -396,7 +397,7 @@ GET /projects/:id/hooks/:hook_id Parameters: -+ `id` (required) - The ID or NAME of a project ++ `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project + `hook_id` (required) - The ID of a project hook ```json @@ -422,7 +423,7 @@ POST /projects/:id/hooks Parameters: -+ `id` (required) - The ID or NAME of a project ++ `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project + `url` (required) - The hook URL + `push_events` - Trigger hook on push events + `issues_events` - Trigger hook on issues events @@ -439,7 +440,7 @@ PUT /projects/:id/hooks/:hook_id Parameters: -+ `id` (required) - The ID or NAME of a project ++ `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project + `hook_id` (required) - The ID of a project hook + `url` (required) - The hook URL + `push_events` - Trigger hook on push events @@ -458,7 +459,7 @@ DELETE /projects/:id/hooks/:hook_id Parameters: -+ `id` (required) - The ID or NAME of a project ++ `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project + `hook_id` (required) - The ID of hook to delete Note the JSON response differs if the hook is available or not. If the project hook @@ -477,7 +478,7 @@ GET /projects/:id/repository/branches Parameters: -+ `id` (required) - The ID of the project ++ `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project ```json [ @@ -539,7 +540,7 @@ GET /projects/:id/repository/branches/:branch Parameters: -+ `id` (required) - The ID of the project. ++ `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project + `branch` (required) - The name of the branch. @@ -553,7 +554,7 @@ PUT /projects/:id/repository/branches/:branch/protect Parameters: -+ `id` (required) - The ID of the project. ++ `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project + `branch` (required) - The name of the branch. @@ -567,7 +568,7 @@ PUT /projects/:id/repository/branches/:branch/unprotect Parameters: -+ `id` (required) - The ID of the project. ++ `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project + `branch` (required) - The name of the branch. |