Conversation
jonasborn
changed the title
Author
|
It might be better to add the new filter params to the end of the definition, as it breaks compatibility:
|
This was referenced Aug 26, 2026
Closed
pull Bot
pushed a commit
to mattdanielbrown/simple-minimal-single-file-php-crud-api
that referenced
this pull request
Aug 28, 2026
Only the plain "filter" parameter was in the document, so a generated client had no way to express an "or" and no idea what the operators were. The numbered and lettered variants can be repeated any number of times, but OpenAPI has no way to say that, every parameter has to be named. How many of them are described is therefore a setting: "openApiFilterCount" is the number of "filter1" to "filterN" parameters and defaults to 3, "openApiSubFilterCount" is the number of lettered ones per numbered one and defaults to 0, as the full grid of them is a lot of parameters for something that few APIs need. The ones that are not described still work. They are appended after the other parameters, as a client generated from the document may pass them by position, which is what the review of mevdschee#980 pointed out. The description of "filter" now lists the operators, the "n" prefix that negates them, the spatial operators and the path syntax that filters on a related table. The numbered and lettered ones say how they combine. The parameters of a list operation moved into OpenApiRecordParameters, which is where the components they refer to are written, so the records builder and the geojson builder cannot disagree about them. Closes mevdschee#571
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
1 participant
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.
Fix for #571