diff options
| author | Nihad Abbasov <narkoz.2008@gmail.com> | 2012-07-25 13:35:41 +0400 |
|---|---|---|
| committer | Nihad Abbasov <narkoz.2008@gmail.com> | 2012-07-25 13:35:41 +0400 |
| commit | 949b1df930bedace1dbd755aaa4a82e8c451a616 (patch) | |
| tree | a9345d5dbcfb44289057b3bd4a3435ed53858c3d /doc/api | |
| parent | 1b95c8bff351f6718ec31ac1de1e48c57bc95d44 (diff) | |
API: update docs
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/issues.md | 10 | ||||
| -rw-r--r-- | doc/api/projects.md | 22 |
2 files changed, 16 insertions, 16 deletions
diff --git a/doc/api/issues.md b/doc/api/issues.md index bad2d474020..0ce14503ffc 100644 --- a/doc/api/issues.md +++ b/doc/api/issues.md @@ -73,7 +73,7 @@ GET /projects/:id/issues Parameters: -+ `id` (required) - The code name of a project ++ `id` (required) - The ID or code name of a project ## Single issue @@ -85,7 +85,7 @@ GET /projects/:id/issues/:issue_id 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 ```json @@ -135,7 +135,7 @@ POST /projects/:id/issues 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 @@ -154,7 +154,7 @@ PUT /projects/:id/issues/:issue_id 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's issue + `title` (optional) - The title of an issue + `description` (optional) - The description of an issue @@ -175,7 +175,7 @@ DELETE /projects/:id/issues/:issue_id 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's issue Status code `200` will be returned on success. diff --git a/doc/api/projects.md b/doc/api/projects.md index c748745e063..cd94cd42328 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -1,6 +1,6 @@ ## List projects -Get a list of authenticated users' projects. +Get a list of authenticated user's projects. ``` GET /projects @@ -63,7 +63,7 @@ GET /projects/:id Parameters: -+ `id` (required) - The code name of a project ++ `id` (required) - The ID or code name of a project ```json { @@ -91,7 +91,7 @@ Parameters: ## Project repository branches -Get a list of project repository branches. +Get a list of project repository branches sorted by name alphabetically. ``` GET /projects/:id/repository/branches @@ -99,7 +99,7 @@ GET /projects/:id/repository/branches Parameters: -+ `id` (required) - The code name of a project ++ `id` (required) - The ID or code name of a project ```json [ @@ -131,7 +131,7 @@ Parameters: ## Project repository tags -Get a list of project repository tags. +Get a list of project repository tags sorted by name in reverse alphabetical order. ``` GET /projects/:id/repository/tags @@ -139,7 +139,7 @@ GET /projects/:id/repository/tags Parameters: -+ `id` (required) - The code name of a project ++ `id` (required) - The ID or code name of a project ```json [ @@ -183,7 +183,7 @@ GET /projects/:id/snippets/:snippet_id 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's snippet ```json @@ -214,7 +214,7 @@ GET /projects/:id/snippets/:snippet_id/raw 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's snippet ## New snippet @@ -227,7 +227,7 @@ POST /projects/:id/snippets 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 @@ -245,7 +245,7 @@ PUT /projects/:id/snippets/:snippet_id 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's snippet + `title` (optional) - The title of a snippet + `file_name` (optional) - The name of a snippet file @@ -264,7 +264,7 @@ DELETE /projects/:id/snippets/:snippet_id 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's snippet Status code `200` will be returned on success. |