Display requestBody description #833 #838
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
RomanHotsiy
requested changes
Mar 15, 2019
|
Great PR! The screenshot is really helpful! |
RomanHotsiy
approved these changes
Mar 15, 2019
|
I am NOT able to make the changes required myself. |
schof
added a commit
to mobileposse/ReDoc
that referenced
this pull request
Mar 20, 2019
* 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) ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.