Skip to content

Commit 1b73af7

Browse files
authored
Merge pull request #12 from gadomski/issues/8-get-ambiguity
Add clarification around GET w/o include
2 parents f749a3c + 98c7e3f commit 1b73af7

File tree

2 files changed

+13
-5
lines changed

2 files changed

+13
-5
lines changed

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [Unreleased]
9+
10+
### Changed
11+
12+
- Clarified behavior of GET requests when `include` is missing ([#12](https://github.com/stac-api-extensions/fields/pull/12))
13+
814
## [v1.0.0-rc.3] - 2022-03-29
915

1016
### Changed
@@ -33,6 +39,7 @@ None
3339
Versions [v1.0.0-rc.1](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.1) and
3440
prior can be found in the [stac-api-spec](https://github.com/radiantearth/stac-api-spec/) repo
3541

42+
[Unreleased]: <https://github.com/stac-api-extensions/fields/compare/v1.0.0-rc.3...main>
3643
[v1.0.0-rc.3]: <https://github.com/stac-api-extensions/fields/tree/v1.0.0-rc.3>
3744
[v1.0.0-rc.2]: <https://github.com/stac-api-extensions/fields/tree/v1.0.0-rc.2>
3845
[v1.0.0-rc.1]: <https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.1>

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -89,11 +89,12 @@ name, e.g., `properties.datetime` or `datetime`.
8989
2. If only `include` is specified, these fields should be the only fields included.
9090
Any additional fields provided beyond those in the `include` list should be kept
9191
to a minimum, as the caller has explicitly stated they do not need them.
92-
3. If only `exclude` is specified, the specified fields should not be
93-
included, but every other field available for the
94-
Item should be included.
95-
4. If `exclude` is specified and `include` is null or an empty
96-
array, then the `exclude` fields should be excluded from the default set.
92+
3. For POST requests, if only `exclude` is specified, the specified fields
93+
should not be included, but every other field available for the Item should be
94+
included.
95+
4. For POST requests, if `exclude` is specified and `include` is null or an
96+
empty array, then the `exclude` fields should be excluded from the default set.
97+
This also applies to GET requests when only `exclude` fields are specified.
9798
5. For nested fields (e.g., `properties.datetime`), the most specific path
9899
should be honored first, and `include` should be preferred over `exclude`. For
99100
example:

0 commit comments

Comments
 (0)