diff options
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/branches.md | 5 | ||||
| -rw-r--r-- | doc/api/issues.md | 8 | ||||
| -rw-r--r-- | doc/api/projects.md | 1 | ||||
| -rw-r--r-- | doc/api/repositories.md | 4 |
4 files changed, 17 insertions, 1 deletions
diff --git a/doc/api/branches.md b/doc/api/branches.md index 31469b6fe97..74386615545 100644 --- a/doc/api/branches.md +++ b/doc/api/branches.md @@ -196,6 +196,8 @@ Parameters: } ``` +It return 200 if succeed or 400 if failed with error message explaining reason. + ## Delete repository branch ``` @@ -207,4 +209,5 @@ Parameters: - `id` (required) - The ID of a project - `branch` (required) - The name of the branch -It return 200 if succeed or 405 if failed with error message explaining reason. +It return 200 if succeed, 404 if the branch to be deleted does not exist +or 400 for other reasons. In case of an error, an explaining message is provided. diff --git a/doc/api/issues.md b/doc/api/issues.md index c12d4528546..a935b146d37 100644 --- a/doc/api/issues.md +++ b/doc/api/issues.md @@ -9,11 +9,15 @@ Get all issues created by authenticated user. This function takes pagination par GET /issues GET /issues?state=opened GET /issues?state=closed +GET /issues?labels=foo +GET /issues?labels=foo,bar +GET /issues?labels=foo,bar&state=opened ``` Parameters: - `state` (optional) - Return `all` issues or just those that are `opened` or `closed` +- `labels` (optional) - Comma-separated list of label names ```json [ @@ -88,12 +92,16 @@ to return the list of project issues. GET /projects/:id/issues GET /projects/:id/issues?state=opened GET /projects/:id/issues?state=closed +GET /projects/:id/issues?labels=foo +GET /projects/:id/issues?labels=foo,bar +GET /projects/:id/issues?labels=foo,bar&state=opened ``` Parameters: - `id` (required) - The ID of a project - `state` (optional) - Return `all` issues or just those that are `opened` or `closed` +- `labels` (optional) - Comma-separated list of label names ## Single issue diff --git a/doc/api/projects.md b/doc/api/projects.md index 8995551b9ea..9f6f6741093 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -248,6 +248,7 @@ POST /projects Parameters: - `name` (required) - new project name +- `path` (optional) - custom repository name for new project. By default generated based on name - `namespace_id` (optional) - namespace for the new project (defaults to user) - `description` (optional) - short project description - `issues_enabled` (optional) diff --git a/doc/api/repositories.md b/doc/api/repositories.md index 1074b78fd73..a412f60c0d9 100644 --- a/doc/api/repositories.md +++ b/doc/api/repositories.md @@ -50,6 +50,7 @@ Parameters: - `id` (required) - The ID of a project - `tag_name` (required) - The name of a tag - `ref` (required) - Create tag using commit SHA, another tag name, or branch name. +- `message` (optional) - Creates annotated tag. ```json [ @@ -71,6 +72,9 @@ Parameters: ] ``` +It returns 200 if the operation succeed. In case of an error, +405 with an explaining error message is returned. + ## List repository tree Get a list of repository files and directories in a project. |