Redoc: Payload json body is wrong example for array

[ntloi95]

In request body schemas, I have an array of string field.
But in payload, it's show only a string.

[RomanHotsiy]

@ntloi95 could you please share your schema and a screenshot of how this is rendered by ReDoc

[ntloi95]

This is error field. It's integrations

This is payload json

This is full schemas

[RomanHotsiy]

Thanks, could you also share the corresponding definition spec/schema ?

[ntloi95]

So sorry, I click to close button because of mistake.
This is definition. I remove some unnecessary things.

{
    "user": {
        "description": "User defines data model for User.",
        "properties": {
            "id": {
                "description": "The id of user.",
                "example": "Wu8LGFBgDAuDzFA8",
                "type": "string"
            },
            "integrations": {
                "description": "Array of fitness partners user may have connected to our app.",
                "example": [
                    "jawbone",
                    "underarmour"
                ],
                "items": {
                    "$ref": "#/components/schemas/integration"
                },
                "type": "array"
            }
        },
        "type": "object"
    },
    "userResponse": {
        "description": "UserResponse represents a response item for User.",
        "properties": {
            "id": {
                "description": "The id of user.",
                "example": "Wu8LGFBgDAuDzFA8",
                "type": "string"
            },
            "integrations": {
                "description": "Array of fitness partners user may have connected to our app.",
                "example": [
                    "jawbone",
                    "underarmour"
                ],
                "items": {
                    "$ref": "#/components/schemas/integration"
                },
                "type": "array"
            }
        },
        "type": "object"
    }
}

[ntloi95]

Wrong on payload is showing userResponse

"responses": {
    "200": {
        "content": {
            "application/json": {
                "schema": {
                    "$ref": "#/components/schemas/userResponse"
                }
            }
        },
        "description": "Update user success."
    }
}

[RomanHotsiy]

I tried your spec and I can't reproduce your issue locally. For me it shows correct example:

Could you share a full simplified schema on which this issue can be reproduced? You can upload it somewhere (e.g. gist) and put link to it into demo: http://rebilly.github.io/ReDoc/

And then share the demo-link here. Thanks!

[ntloi95]

Hi,
This is simplified schema I edited. It can reproduce bug.

https://raw.githubusercontent.com/ntloi95/hack/master/redoc-v6.json

[RomanHotsiy]

You have an issue in your spec:

"requestBody": {
  "content": {
    "application/json": {
      "schema": {
        "properties": {
          "integrations": {
            "description": "Integrations",
            "enum": [ // <---- HERE
                "jawbone",
                "underarmour",
                "healthkit",
                "googlefit"
            ],
            "in": "body",
            "items": {
              "$ref": "#/components/schemas/integration"
            },
            "name": "integrations",
            "type": "array"
          }
        },
        "type": "object"
      }
    }
  },
  "required": true

Enum on this level according to the spec means that value of this field (integrations MUST be one of the enum values (strings) while field type is array so this schema is invalid.
If you need to specify possible values for items you should put enum inside items. But in your case, just remove enum as you anyway have same enum in integration definition

ReDoc is rendering your spec correctly

[ntloi95]

Remove "enum" is ok. ReDoc render correctly.
Thank you very much indeed.