Align OpenAPI filter schema with scalar filter values#31
Merged
mindpower merged 1 commit intoJun 21, 2026
Merged
Conversation
mindpower
approved these changes
Jun 21, 2026
Collaborator
|
Thanks @yangbaechu ! |
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
2 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.
Summary
This updates the OpenAPI schema for
QueryModel.filtervalues to match the existing prose spec and CDDL.The documented contract already allows scalar filter values:
spec/ard.md, Query Model field table:values are arrays (a bare scalar is accepted as a single-element array).spec/schemas/ard.cddl,query-model:? filter: {* tstr => ([+ tstr] / tstr)}.spec/schemas/ard.openapi.yaml,QueryModel.filterdescription:Values are arrays or scalar values.However, before this PR, the formal OpenAPI schema only allowed
array<string>, so generated clients could reject scalar filter values even though the prose and CDDL allow them.Change
QueryModel.filter.additionalPropertiesfromarray<string>tooneOf: string | array<string>.Notes
This does not change the documented API contract. It makes the machine-readable OpenAPI schema match the existing prose and CDDL behavior so generated clients can represent scalar filter values correctly.