API: documentation contains infos to status codes in README file.
All the info to return codes from the API functions are available in the `README.md` file as suggested.
This commit is contained in:
parent
b5ef6d2268
commit
39114d259c
11 changed files with 36 additions and 475 deletions
|
@ -69,13 +69,6 @@ GET /issues
|
|||
]
|
||||
```
|
||||
|
||||
Return values:
|
||||
|
||||
+ `200 Ok` on success and the list of issues
|
||||
+ `401 Unauthorized` if user is not authenticated
|
||||
+ `404 Not Found` if something fails
|
||||
|
||||
|
||||
|
||||
## List project issues
|
||||
|
||||
|
@ -90,12 +83,6 @@ Parameters:
|
|||
|
||||
+ `id` (required) - The ID of a project
|
||||
|
||||
Return values:
|
||||
|
||||
+ `200 Ok` on success and the list of project issues
|
||||
+ `401 Unauthorized` if user is not authenticated
|
||||
+ `404 Not Found` if project ID not found
|
||||
|
||||
|
||||
## Single issue
|
||||
|
||||
|
@ -150,12 +137,6 @@ Parameters:
|
|||
}
|
||||
```
|
||||
|
||||
Return values:
|
||||
|
||||
+ `200 Ok` on success and the list of project issues
|
||||
+ `401 Unauthorized` if user is not authenticated
|
||||
+ `404 Not Found` if project ID or issue ID not found
|
||||
|
||||
|
||||
## New issue
|
||||
|
||||
|
@ -174,13 +155,6 @@ Parameters:
|
|||
+ `milestone_id` (optional) - The ID of a milestone to assign issue
|
||||
+ `labels` (optional) - Comma-separated label names for an issue
|
||||
|
||||
Return values:
|
||||
|
||||
+ `201 Created` on success and the newly created project issue
|
||||
+ `400 Bad Request` if the required attribute title is not given
|
||||
+ `401 Unauthorized` if user is not authenticated
|
||||
+ `404 Not Found` if project ID not found
|
||||
|
||||
|
||||
## Edit issue
|
||||
|
||||
|
@ -201,12 +175,6 @@ Parameters:
|
|||
+ `labels` (optional) - Comma-separated label names for an issue
|
||||
+ `closed` (optional) - The state of an issue (0 = false, 1 = true)
|
||||
|
||||
Return values:
|
||||
|
||||
+ `200 Ok` on success and the update project issue
|
||||
+ `401 Unauthorized` if user is not authenticated
|
||||
+ `404 Not Found` if project ID or issue ID not found
|
||||
|
||||
|
||||
## Delete existing issue (**Deprecated**)
|
||||
|
||||
|
@ -223,6 +191,3 @@ Parameters:
|
|||
+ `id` (required) - The project ID
|
||||
+ `issue_id` (required) - The ID of the issue
|
||||
|
||||
Return values:
|
||||
|
||||
+ `405 Method Not Allowed` is always returned, because the function is deprecated
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue