Allow providing filter-lang to search #128
Merged
Conversation
This file contains 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
The user can optionally provide a filter-lang parameter to the ItemSearch endpoint when using filter. This preserves the existing behavior of defaulting to `cql-json` when no value is provided, so it should be backwards compatible with existing code. By optionally providing a new value, such as `cql2-json`, the user can supply filters with different JSON language variants.
Codecov Report
@@ Coverage Diff @@
## main #128 +/- ##
==========================================
+ Coverage 80.32% 81.04% +0.71%
==========================================
Files 9 9
Lines 549 554 +5
==========================================
+ Hits 441 449 +8
+ Misses 108 105 -3
Continue to review full report at Codecov.
|
matthewhanson
approved these changes
Jan 4, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description:
The user can optionally provide a filter-lang parameter to the
ItemSearch endpoint when using filter. This preserves the existing
behavior of defaulting to
cql-jsonwhen no value is provided, so itshould be backwards compatible with existing code. By optionally
providing a new value, such as
cql2-json, the user can supply filterswith different JSON language variants.
This change minimally anticipates the forthcoming STAC-API beta release
of the filter fragment while preserving existing behavior. After the CQL2
changes are released in the next beta, it's likely we'll need a larger refactor
around supporting cql2-text, new conformance classes, etc. In the meantime,
this change will allow Planetary Computer users run cql2-json filters which are
supported in our pgstac implementation.
PR Checklist: