Support limitng parameter values (enums) #713
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.
Adds support for limiting parameter values. Works with either a PHP 8.1 enum or an array of values.
Also supported in docblocks:
This will:
enum
key in the OpenAPI specIt does not currently restrict the values that can be entered in Try It Out, as there may still be some value in seeing how invalid values are responded to.
This may be a breaking change, as it replaces the earlier manual description setting (automatically generated for validation rules) with a structured field.
In the internal Scribe API, this adds a new
enumValues
field to the parameter types. This is an array of all valid values.Closes #626