feat: add support for const keyword #133
Merged
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.
Describe the pull request
Add support for the const keyword available in OpenAPI 3.1.0. When a schema defines const, it now displays the allowed value with an "Allowed value:" label.
Why
OpenAPI 3.1.0 is a superset of JSON Schema Draft 2020-12 and supports the const keyword (OpenAPI 3.1.0 Specification). The const keyword indicates that a value must be exactly equal to a specified constant value (JSON Schema Draft 2020-12).
Previously, starlight-openapi ignored the const keyword, so the allowed value was not displayed in the documentation.
How
Added const property to the Items type
Implemented display of "Allowed value:" tag in Items.astro component when const is present
Uses a consistent UI pattern with the existing enum display ("Allowed values:")
Screenshots
N/A