specify further error cases

[ci skip]
pull/2345/head
Jan Sandbrink 10 years ago
parent b93fdec137
commit 54c3bfc787
  1. 42
      doc/apiv3-documentation.apib

@ -2660,17 +2660,35 @@ The response will be the collection of *all* the watchers for the given work pac
+ Request (application/json) + Request (application/json)
{ {
"users": [ "users": [
{ "href": "/api/v3/users/1" }, { "href": "/api/v3/users/1" },
{ "href": "/api/v3/users/2" } { "href": "/api/v3/users/2" }
] ]
} }
+ Response 200 (application/hal+json) + Response 200 (application/hal+json)
[Watchers][] [Watchers][]
+ Response 400 (application/hal+json)
Occurs when the client did not send a valid JSON object in the request body.
For example:
* The request did not contain a single JSON object
* The JSON object did not contain the key `users`
* The value of `users` was not an array of link objects
+ Body
{
"_type": "Error",
"errorIdentifier": "urn:openproject-org:api:v3:errors:InvalidRequestBody",
"message": "The request body was not a single JSON object."
}
+ Response 403 (application/hal+json) + Response 403 (application/hal+json)
Returned if the client does not have sufficient permissions. Returned if the client does not have sufficient permissions.
@ -2706,6 +2724,18 @@ The response will be the collection of *all* the watchers for the given work pac
"message": "The specified work package does not exist." "message": "The specified work package does not exist."
} }
+ Response 422 (application/hal+json)
Returned if the client tries to specify a link to a resource that is not a user.
+ Body
{
"_type": "Error",
"errorIdentifier": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation",
"message": "Expected resources of type 'User', but got a 'Status'.",
}
## Remove Watcher [/api/v3/work_packages/{work_package_id}/watchers/{id}] ## Remove Watcher [/api/v3/work_packages/{work_package_id}/watchers/{id}]
## Remove watcher [DELETE] ## Remove watcher [DELETE]

Loading…
Cancel
Save