Skip to content
This repository was archived by the owner on Apr 2, 2025. It is now read-only.

Commit 1e7e19a

Browse files
author
Phil Varner
committed
add better documentation
1 parent b0d2fc5 commit 1e7e19a

File tree

3 files changed

+19
-0
lines changed

3 files changed

+19
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ guaranteed to be not correct.
88
STAPI FastAPI provides an `fastapi.APIRouter` which must be included in
99
`fastapi.FastAPI` instance.
1010

11+
12+
## ADRs
13+
14+
ADRs can be found in in the [adrs](./adrs/README.md) directory.
15+
1116
## Development
1217

1318
It's 2024 and we still need to pick our poison for a 2024 dependency management

adrs/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# ADRs
2+
3+
- [Constraints and Opportunity Properties](./constraints.md)

adrs/constraints.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Constraints and Opportunity Properties
2+
3+
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.
4+
5+
For example, for the concept of "off_nadir":
6+
7+
The Constraint will be a term "off_nadir" that can be a value 0 to 45.
8+
This is used in a CQL2 filter to the Opportunities Search endpoint to restrict the allowable values from 0 to 15
9+
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.
10+
An Order is created with the original filter and other fields.
11+
The Order is fulfilled with a STAC Item that has an off_nadir value of 4.8.

0 commit comments

Comments
 (0)