fix(oas3): reverse readOnly/writeOnly handling for callback request bodies#10818
Open
maruthang wants to merge 1 commit intoswagger-api:masterfrom
Open
fix(oas3): reverse readOnly/writeOnly handling for callback request bodies#10818maruthang wants to merge 1 commit intoswagger-api:masterfrom
maruthang wants to merge 1 commit intoswagger-api:masterfrom
Conversation
…odies Callback request bodies are sent BY the API, so readOnly/writeOnly semantics should be reversed: include readOnly properties and exclude writeOnly properties. Detect callbacks by checking if specPath includes "callbacks" and pass isCallback prop to RequestBody component. Fixes swagger-api#6294
This file contains hidden or 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
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.
Description
Added
isCallbackprop to theRequestBodycomponent, detected by checking ifspecPathincludes"callbacks"in theParameterscomponent. WhenisCallbackis true, the readOnly/writeOnly behavior is reversed across all 5 relevant places inrequest-body.jsx:getDefaultRequestBodyValue): usesincludeReadOnly: trueinstead ofincludeWriteOnly: trueincludeReadOnly: trueinstead ofincludeWriteOnly: trueisCallbacktogetDefaultRequestBodyValueincludeReadOnly={true}andincludeWriteOnly={false}for callbacksMotivation and Context
Fixes #6294
Callback request bodies are sent by the API to the consumer, not by the consumer to the API. This means:
Previously, Swagger UI treated callback request bodies the same as regular request bodies, incorrectly omitting readOnly and including writeOnly properties.
How Has This Been Tested?
test/unit/core/plugins/oas3/request-body.js:getDefaultRequestBodyValueusesincludeWriteOnlyfor regular requestsgetDefaultRequestBodyValueusesincludeReadOnlyfor callback requestsisCallbackparameter is false when not providedScreenshots (if appropriate):
N/A - Logic-only change, no visual changes.
Checklist
My PR contains...
src/is unmodified: changes to documentation, CI, metadata, etc.)package.json)My changes...
Documentation
Automated tests