Repository navigation
Add requestBody component (#886) - #1080
Closed
ansh-rohilla wants to merge 1 commit into
Closed
ansh-rohilla wants to merge 1 commit into
ansh-rohilla wants to merge 1 commit into
Conversation
Add support for OpenAPI v3 requestBodies components: - Register request_body in COMPONENT_SUBSECTIONS for OpenAPI v3. - Add Components.request_body() for registering reusable request bodies. - Support lazy registration and resolution of referenced request bodies in operations. - Add request_body_helper to BasePlugin and MarshmallowPlugin. - Add test coverage and validation against OpenAPI schema.
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
2 participants
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.
Summary
Adds support for OpenAPI v3 reusable
requestBodiescomponents as requested in #886.Changes
"request_body": "requestBodies"toCOMPONENT_SUBSECTIONS[3]inapispec/utils.py.request_bodiesandrequest_bodies_lazydictionaries onComponents.Components.request_body(component_id, component=None, *, lazy=False, **kwargs)._resolve_refs_in_request_bodyto userequest_body.get("content", {})to safely handle referenced bodies._resolve_refs_in_operationto resolve string references forrequestBodyviaget_ref("request_body", ...).request_body_helpertoBasePlugin.request_body_helpertoMarshmallowPluginto support resolving marshmallow schemas in request body components.get_request_bodieshelper intests/utils.py.tests/test_core.pyfor registration, method chaining, duplicate detection, schema/examples ref resolution, lazy registration, and operation reference resolution withvalidate_spec.tests/test_ext_marshmallow.pyfor registering request bodies with marshmallow schemas.unreleasedfeatures.Fixes #886