Add support for booleans and floats in OpenAPI Schema const
#1086
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 encountered the problem that the Pydantic Schemas for the OpenAPI spec, do not support the
const
keyword if it is of typeboolean
.Why do I think it should be supported?
The OpenAPI Specification explicitly marks the
const
keyword as unsupported. Nevertheless it should not result in exceptions if the keyword is present.I furthermore did not find any evidence in JSON Schema that would limit the types valid for the
const
keyword to bestring
orinteger
only.Thus I suggest allowing
boolean
as well asfloats
as constant values.Example
The following is minimal example in FastAPI that would produce such a schema:
Generated OpenAPI Specification