ryankert01 opened a new pull request, #449: URL: https://github.com/apache/yunikorn-site/pull/449
### 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: ``` ### 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` ``` Remove the error examples as they do not add any detail required ### What type of PR is it? * [ ] - Bug Fix * [x] - Improvement * [ ] - Feature * [x] - Documentation * [ ] - Hot Fix * [ ] - Refactoring ### Todos * [ ] - Task ### What is the Jira issue? https://issues.apache.org/jira/browse/YUNIKORN-2655 ### How should this be tested? ### Screenshots (if appropriate) ### Questions: * [ ] - The licenses files need update. * [ ] - There is breaking changes for older versions. * [ ] - It needs documentation. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
