Use singular field key names: `include` and `exclude`

stac-utils / pystac-client

Python client for searching STAC APIs

https://pystac-client.readthedocs.io

Other

161 stars 48 forks source link

Use singular field key names: `include` and `exclude` #690

Closed kurtmckee closed 5 months ago

kurtmckee commented 5 months ago

Related Issue(s):

Description:

This PR updates the names of the Fields extension keys. Previously they were plural (includes / excludes) but this did not align with the Fields extension documentation, and did not work when interacting with a STAC API. The keys are renamed to include and exclude by this PR.

PR Checklist:

[x] Code is formatted
[x] Tests pass
[x] Changes are added to the CHANGELOG

Fixes #689

codecov-commenter commented 5 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 93.87%. Comparing base (21435b0) to head (9bb4055). Report is 42 commits behind head on main.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #690 +/- ## ========================================== + Coverage 93.43% 93.87% +0.44% ========================================== Files 13 13 Lines 990 996 +6 ========================================== + Hits 925 935 +10 + Misses 65 61 -4 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.