[YUNIKORN-2655] Cleanup REST API documentation #449
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is this PR for?
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:
Remove the error examples as they do not add any detail required
What type of PR is it?
Todos
What is the Jira issue?
https://issues.apache.org/jira/browse/YUNIKORN-2655
How should this be tested?
Screenshots (if appropriate)
Questions: