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

Split constraints and opportunity properties into two concepts #113

Merged
merged 6 commits into from
Dec 11, 2024

Conversation

jkeifer
Copy link
Member

@jkeifer jkeifer commented Nov 26, 2024

Related Issue(s):

  • n/a

Proposed Changes:

Previously, the Constraints and Opportunity Properties were the same concept/representation. However, these represent distinct but related attributes. Constraints represents the terms that can be used in the filter sent to the Opportunities Search and Order Create endpoints. These are frequently the same or related values that will be part of the STAC Items that are used to fulfill an eventual Order. Opportunity Properties represent the expected range of values that these STAC Items are expected to have.

For example, for the concept of "off_nadir":

  • The Constraint will be a term "off_nadir" that can be a value 0 to 45.
  • This is used in a CQL2 filter to the Opportunities Search endpoint to restrict the allowable values from 0 to 15
  • The Opportunity that is returned from Search has an Opportunity Property "off_nadir" with a description that the value of this field in the resulting STAC Items will be between 4 and 8, which falls within the filter restriction of 0-15.
  • An Order is created with the original filter and other fields.
  • The Order is fulfilled with a STAC Item that has an off_nadir value of 4.8.

PR Checklist:

  • I have added my changes to the CHANGELOG or a CHANGELOG entry is not required.

@philvarner philvarner changed the title Sketch of constraints/opportunity properties split Split constraints and opportunity properties into two concepts Dec 10, 2024
Copy link

@trevorskaggs trevorskaggs left a comment

Choose a reason for hiding this comment

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

:shipit:

@philvarner philvarner merged commit 15d448b into main Dec 11, 2024
2 checks passed
@philvarner philvarner deleted the jak/model-idea branch December 11, 2024 18:26
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.

3 participants