Repository navigation
feat(marshmallow): support Tuple field in OpenAPI 3.1+ (closes #399) - #1084
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
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.
Summary
Implements support for
marshmallow.fields.Tupletranslation into OpenAPI 3.1+ schema definitions according to the JSON Schema 2020-12 standard (fixes #399).Per discussion in #399:
fields.Tupleinto{"type": "array", "prefixItems": [...], "items": False}.APISpecErroris raised indicating thatTupleis only supported in OpenAPI 3.1.0 and above.apispec.core.Components._resolve_refs_in_schemaandSchemaResolver.resolve_schema_dict:itemsresolution guards against boolean schemas (such asitems: False) to prevent them from being incorrectly mutated into reference objects ({'$ref': '#/components/schemas/False'}).prefixItems.marshmallow.fields.TupleinDEFAULT_FIELD_MAPPING,_VALID_PROPERTIES,field2length, and addedtuple2properties.Testing
tests/test_ext_marshmallow_field.pycovering scalar fields, empty tuples, nullable tuples, Length validators, dump/load only, metadata, and nested tuples.tests/test_ext_marshmallow.pytesting schemas with tuples, nested schemas with references inside tuples, and operations with tuples validated againstopenapi-spec-validator.tests/test_core.pyfor OpenAPI 3.1 tuple schemas withprefixItemsanditems: False.pytest,mypy,ruff,pre-commit).