Wilfred Spiegelenburg created YUNIKORN-2655:
-----------------------------------------------
Summary: Cleanup REST API documentation
Key: YUNIKORN-2655
URL: https://issues.apache.org/jira/browse/YUNIKORN-2655
Project: Apache YuniKorn
Issue Type: Task
Components: documentation
Reporter: Wilfred Spiegelenburg
The REST API documentation is not up to date with the current behaviour as it
does not show any 400 or 404 errors returned by a number of API calls.
The error response only shows a 500 code with the same message for each call.
We should move to a simple list for each call showing the applicable errors
like this:
{code:java}
### Error responses
**Code** : `400 Bad Request` (URL query is invalid, missing partition name)
**Code** : `404 Not Found` (Partition not found)
**Code** : `500 Internal Server Error` {code}
Remove the error examples as they do not add any detail required
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
