Redoc: Description of array items is not appeared on response.

Created on 19 Feb 2020  路  3Comments  路  Source: Redocly/redoc

I found that UI would not show the description of items with the referenced schema.

I think this had mentioned In #538, but not fixed?

What swagger-UI showed:
鎴湒 2020-02-19 涓嬪崍4 27 20

What redoc showed, which lack of description "bar schema description.":
鎴湒 2020-02-19 涓嬪崍4 27 30

I test it with redoc-cli version 0.9.4, and the example YAML:

openapi: "3.0.0"
info:
  title: test
  version: "0.0.0"
paths:
  /foo:
    get:
      summary: foo
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                description: array of bars
                type: array
                items:
                  $ref: "#/components/schemas/bar"
components:
  schemas:
    bar:
      description: bar schema description.
      type: object
      properties:
        name:
          type: string
enhancement help wanted

Most helpful comment

All 3 comments

Where do you see this description to be rendered? PR would be appreciated!

Where do you see this description to be rendered?

I suggest that just render it before the "Array[", I made a mocking picture.
74816647-8270ee80-5336-11ea-9e1a-3b6edd11c5df

PR would be appreciated!

I would love to contribute to this project, but unfortunately, I know nothing about react and I am not good at Javascript either.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

skllcrn picture skllcrn  路  3Comments

raderio picture raderio  路  4Comments

lafrech picture lafrech  路  3Comments

JFCote picture JFCote  路  3Comments

ahshum picture ahshum  路  3Comments