Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use singular field key names: include and exclude #690

Merged

Conversation

kurtmckee
Copy link
Contributor

@kurtmckee kurtmckee commented May 22, 2024

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:

  • Code is formatted
  • Tests pass
  • Changes are added to the CHANGELOG

Fixes #689

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files
@@            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     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@gadomski gadomski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks for the fix! I added a VCR test against Earth Search to check a real world example as well.

@gadomski gadomski enabled auto-merge (squash) May 23, 2024 13:59
@gadomski gadomski merged commit 8f12756 into stac-utils:main May 23, 2024
17 checks passed
@kurtmckee kurtmckee deleted the fix-include-exclude-key-names-issue-689 branch May 23, 2024 14:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fields extension uses incorrect plural includes and excludes
3 participants