validate spec #253
Open
validate spec #253
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
E openapi_spec_validator.validation.exceptions.OpenAPIValidationError: {} should be non-empty
E
E Failed validating 'minProperties' in schema['properties']['paths']['patternProperties']['^/']['else']['properties']['get']['properties']['responses']:
E {'$comment': 'https://spec.openapis.org/oas/v3.1.0#responses-object',
E 'type': 'object',
E 'properties': {'default': {'$ref': '#/$defs/response-or-reference'}},
E 'patternProperties': {'^[1-5](?:[0-9]{2}|XX)$': {'$ref': '#/$defs/response-or-reference'}},
E 'minProperties': 1,
E '$ref': '#/$defs/specification-extensions',
E 'unevaluatedProperties': False,
E 'if': {'$comment': 'either default, or at least one response code '
E 'property must exist',
E 'patternProperties': {'^[1-5](?:[0-9]{2}|XX)$': False}},
E 'then': {'required': ['default']}}
E
E On instance['paths']['/book']['get']['responses']:
E {}
- Remove 'default' key if it's None to maintain OpenAPI spec compliance. - Only return valid links. - validate schemas in all tests I am not entirely happy with the links, because we silently ignore things that the user provided. We should either - raise exceptions and change the tests, so that only valid links can be specified (my preferred option) or - warn the user. I did not implement this, because logging is not used at all and I wanted to keep the library's style intact.
5 tasks
luolingchun
reviewed
Jan 20, 2026
| @model_serializer(mode="wrap", when_used="json") | ||
| def _serialize(self, serializer, info): | ||
| data = serializer(self) | ||
| # Remove 'default' key if it's None to maintain OpenAPI spec compliance |
Owner
Contributor
There was a problem hiding this comment.
(IIRC) There are cases when "default=None" is needed to be documented. Like, the field requires a value, None is valid, and it's the default. I already use openapi-spec-validator and don't see what validation it breaks though from a quick check of the pull request.
Owner
|
@felixhummel Thanks for your contribution, validating against the OpenAPI specification is more secure. I don't think You should create a new test script instead of modifying all existing tests, which is not good for maintenance. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
We need clean specs to generate clean clients.
I propose to validate the spec in the tests.
I also made changes to make the spec compliant.
Please note my comment in cd496a5 concerning links.
Checklist:
pytest testsand no failed.ruff check flask_openapi3 tests examplesand no failed.ruff format flask_openapi3 tests examplesand no failed.mypy flask_openapi3and no failed.mkdocs serveand no failed.