Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Description of array items is not appeared on response. #1179

Open
zmes50416 opened this issue Feb 19, 2020 · 3 comments
Open

Description of array items is not appeared on response. #1179

zmes50416 opened this issue Feb 19, 2020 · 3 comments

Comments

@zmes50416
Copy link

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
@RomanHotsiy
Copy link
Member

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

@zmes50416
Copy link
Author

zmes50416 commented May 12, 2020

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.

@ghost
Copy link

ghost commented Oct 30, 2020

Would this PR assist?

Add the title tag to the Array () definition within a schema block

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants