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.

Sign up for GitHub

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

Jump to bottom

No description on schemas (e.g. response body schemas) #598

Open
jaroslawr opened this issue Aug 7, 2018 · 4 comments · May be fixed by #1497
Open

No description on schemas (e.g. response body schemas) #598

jaroslawr opened this issue Aug 7, 2018 · 4 comments · May be fixed by #1497
Assignees
@AntonKozachuk
Labels
Type: Enhancement

Comments

@jaroslawr
Copy link

jaroslawr commented Aug 7, 2018 •
edited
Loading

ObjectSchema.tsx does not render schema description, even though the OpenAPI spec allows it, including using CommonMark in description:

https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#schemaObject
@wdonne
Copy link

wdonne commented Nov 9, 2018

The requestBody element itself can also have a description, which is not rendered either.

This was referenced Mar 8, 2019
Open
Merged
@stnguyen90 stnguyen90 mentioned this issue Sep 9, 2019
Closed
@kvaleev
Copy link

kvaleev commented May 4, 2020

Any updates on this issue?

@nartamonov
Copy link

Very needed, it's the main showstopper at now for me.

@aleung aleung linked a pull request Jan 12, 2021 that will close this issue
Open
@HansAarneLiblik
Copy link

Any updates on this ?

Swagger displays response schema description
image

ReDoc does not
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@AntonKozachuk AntonKozachuk

Labels
Type: Enhancement
Projects
None yet
Milestone
No milestone
7 participants
@jaroslawr @nartamonov @kvaleev @RomanHotsiy @wdonne @HansAarneLiblik @AntonKozachuk