diff options
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/notes.md | 10 | ||||
| -rw-r--r-- | doc/api/projects.md | 7 |
2 files changed, 10 insertions, 7 deletions
diff --git a/doc/api/notes.md b/doc/api/notes.md index a4ba2826076..eef4b63fcaf 100644 --- a/doc/api/notes.md +++ b/doc/api/notes.md @@ -89,7 +89,7 @@ Parameters: Get an issue note. ``` -GET /projects/:id/issues/:issue_id/:notes/:note_id +GET /projects/:id/issues/:issue_id/notes/:note_id ``` Parameters: @@ -103,7 +103,7 @@ Parameters: Get a snippet note. ``` -GET /projects/:id/issues/:snippet_id/:notes/:note_id +GET /projects/:id/issues/:snippet_id/notes/:note_id ``` Parameters: @@ -127,7 +127,7 @@ Parameters: + `id` (required) - The ID of a project + `body` (required) - The content of a note -Will return created note with status `201 Created` on success, or `404 Not found` on fail. +Will return created note with status `201 Created` on success, `400 Bad Request` if the body attribute is missing or `404 Not found` on fail. ### New issue note @@ -144,7 +144,7 @@ Parameters: + `issue_id` (required) - The ID of an issue + `body` (required) - The content of a note -Will return created note with status `201 Created` on success, or `404 Not found` on fail. +Will return created note with status `201 Created` on success, `400 Bad Request` if the body attribute is missing or `404 Not found` on fail. ### New snippet note @@ -160,4 +160,4 @@ Parameters: + `snippet_id` (required) - The ID of an snippet + `body` (required) - The content of a note -Will return created note with status `201 Created` on success, or `404 Not found` on fail. +Will return created note with status `201 Created` on success, `400 Bad Request` if the body attribute is missing or `404 Not found` on fail. diff --git a/doc/api/projects.md b/doc/api/projects.md index 82bb0c0d561..03731427703 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -197,7 +197,10 @@ Parameters: + `id` (required) - The ID of a project + `user_id` (required) - The ID of a team member -Status code `200` will be returned on success. +Status code `200 OK` will be returned on success. This method is idempotent and call be called multiple +times with the same parameters. Revoking team membership for a user who is not currently a team member is +considered success. Please note that the returned JSON currently differs slightly. Thus you should not +rely on the returned JSON structure. ## List project hooks @@ -221,7 +224,7 @@ Get hook for project GET /projects/:id/hooks/:hook_id ``` -Parameters: +Parameters:ยง + `id` (required) - The ID of a project + `hook_id` (required) - The ID of a project hook |