[GEODE-7074] improve Cluster Management Rest api Swagger documentation

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 1.11.0
• Component/s: management
• Assignee: Unassigned
• Reporter: Jack Weissburg
• Created: 12/Aug/19 16:54
• Updated: 30/Dec/19 18:52
• Resolved: 19/Dec/19 20:30

Description

1. the api operation names
2. the json request/response wording changes.
3. If you do a POST on the "pdx" endpoint and give it a bad json input it returns 400 Error: Bad Request but this in not documented in swagger (swagger only mentions: 200, 201, 401, 403, 404, and 500).
   The 400 returns the following json output: { "statusCode": "ILLEGAL_ARGUMENT", "statusMessage": "JSON parse error: Unexpected end-of-input: expected close marker for Object (start marker at [Source: (PushbackInputStream); line: 1, column: 1]); nested exception is com.fasterxml.jackson.core.io.JsonEOFException: Unexpected end-of-input: expected close marker for Object (start marker at [Source: (PushbackInputStream); line: 1, column: 1])\n at [Source: (PushbackInputStream); line: 6, column: 103]." }
4. Swagger will show example json docs and it always shows "statusCode" to be "ILLEGAL_ARGUMENT".
   I think this is because it is the first enum value. If we changed "OK" to be the first the swagger examples would be better.
5. hide "group, groups, " for config pdx from Swagger docs.

 

Issue Links

• links to: GitHub Pull Request #3907
• links to: GitHub Pull Request #4174