[jira] [Resolved] (GEODE-7074) improve Cluster Management Rest api Swagger documentation

["Darrel Schneider (Jira)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/GEODE-7074?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Darrel Schneider resolved GEODE-7074.
-------------------------------------
    Fix Version/s: 1.11.0
       Resolution: Fixed

> improve Cluster Management Rest api Swagger documentation
> ---------------------------------------------------------
>
>                 Key: GEODE-7074
>                 URL: https://issues.apache.org/jira/browse/GEODE-7074
>             Project: Geode
>          Issue Type: Improvement
>          Components: management
>            Reporter: Jack Weissburg
>            Priority: Major
>             Fix For: 1.11.0
>
>          Time Spent: 50m
>  Remaining Estimate: 0h
>
> # the api operation names
>  # the json request/response wording changes.
>  # 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]."
> }
>  # 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.
>  # hide "group, groups, " for config pdx from Swagger docs.
>  



--
This message was sent by Atlassian Jira
(v8.3.4#803005)