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

Request body description is not displayed #833

Open
null-dev opened this issue Mar 3, 2019 · 4 comments
Open

Request body description is not displayed #833

null-dev opened this issue Mar 3, 2019 · 4 comments

Comments

@null-dev
Copy link

null-dev commented Mar 3, 2019

According to the OpenAPI spec, the request body is able to have a description: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#requestBodyObject

It doesn't look like this is displayed in ReDoc.
@tomjankes
Copy link
Contributor

After migrating to ReDoc we noticed that some of descriptions from our OpenAPI 3.0 spec that were previously visible in swagger-ui has disappeared.

One of the examples is description in requestBody (this missing feature was already referenced in comment to issue #598 (comment) and in this issue).

We were able to mitigate this problem by moving relevant descriptions from requestBodies up to request method level, but for the sake of completeness i decided to propose this PR.

Please comment if you are interested in incorporating this feature and if you are ok with this particular implementation.

screenshot 2019-03-08 at 11 04 11

RomanHotsiy pushed a commit that referenced this issue Mar 15, 2019
@tomjankes @RomanHotsiy
feat: display requestBody description #833 (#838)
56ca371
schof added a commit to mobileposse/ReDoc that referenced this issue Mar 20, 2019
@schof
Merge branch 'master' into pr-681
b311281 
* master: (73 commits)
  chore: fixes typo in error message for detecting a circular dependency in theme.ts (Redocly#852)
  chore: minor refactor
  fix: tidy up non-redoc vendor extension presentation (Redocly#847)
  chore(cli): redoc-cli v0.8.3
  fix(cli): add node-libs-browser to the deps
  chore(cli): redoc-cli v0.8.2
  fix: fix redoc-cli broken dependencies
  chore: Release 2.0.0-rc.4 🔖
  feat: display requestBody description Redocly#833 (Redocly#838)
  fix: move swagger2openapi to deps because of missing transitive deps
  chore(cli): redoc-cli v0.8.0
  chore: update peerDeps before release
  chore: Release 2.0.0-rc.3 🔖
  fix: add extra deref step for anyOf/oneOf variants
  chore: Remove duplicate re-export from index.ts (Redocly#842)
  fix: pin lunr version in ReDoc
  chore: fix cli declarations
  feat: support externalValue for examples
  chore: update deps
  docs: Fixed docker README, added missing redocly repo name (Redocly#841)
  ...
@kvaleev
Copy link

kvaleev commented May 4, 2020

Any updates on this issue?

@RomanHotsiy RomanHotsiy mentioned this issue Jun 27, 2020
Open
@hvt
Copy link

hvt commented Jul 8, 2020

I'm also running into this problem. Not a TypeScript expert, but it looks like it is implemented in the template:
https://github.com/Redocly/redoc/blob/master/src/components/Parameters/Parameters.tsx#L49-L82

@aleung
Copy link

aleung commented Jan 12, 2021

Isn't it fixed by #838 already?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@aleung @hvt @kvaleev @tomjankes @null-dev