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

Don't deactivate other search parameters when filtering with ids #125

Merged
merged 4 commits into from
May 5, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]

### Changed
- Passing the `ids` parameter to an item search does not deactivate other query parameters [#125](https://github.com/radiantearth/stac-api-spec/pull/125)
- The first extent in a Collection is always the overall extent, followed by more specific extents. [opengeospatial/ogcapi-features#520](https://github.com/opengeospatial/ogcapi-features/pull/520)

## [v1.0.0-beta.1] - 2020-12-10
Expand Down
2 changes: 1 addition & 1 deletion item-search/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ The core parameters for STAC search are defined by OAFeat, and STAC adds a few p
| bbox | \[number] | OAFeat | Requested bounding box. Represented using either 2D or 3D geometries. The length of the array must be 2*n where n is the number of dimensions. The array contains all axes of the southwesterly most extent followed by all axes of the northeasterly most extent specified in Longitude/Latitude or Longitude/Latitude/Elevation based on [WGS 84](http://www.opengis.net/def/crs/OGC/1.3/CRS84). When using 3D geometries, the elevation of the southwesterly most extent is the minimum elevation in meters and the elevation of the northeasterly most extent is the maximum. |
| datetime | string | OAFeat | Single date+time, or a range ('/' seperator), formatted to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6). Use double dots `..` for open date ranges. |
| intersects | GeoJSON Geometry | STAC | Searches items by performing intersection between their geometry and provided GeoJSON geometry. All GeoJSON geometry types must be supported. |
| ids | \[string] | STAC | Array of Item ids to return. All other filter parameters that further restrict the number of search results (except `next` and `limit`) are ignored |
| ids | \[string] | STAC | Array of Item ids to return. |
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think we need to rephrase this, but I think it's fine for now.

| collections | \[string] | STAC | Array of one or more Collection IDs to include in the search for items. Only Items in one of the provided Collections will be searched |

Only one of either **intersects** or **bbox** should be specified. If both are specified, a 400 Bad Request response
Expand Down
6 changes: 2 additions & 4 deletions item-search/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,7 @@ components:
name: ids
in: query
description: |-
Array of Item ids to return. All other filter parameters that further
restrict the number of search results are ignored
Array of Item ids to return.
required: false
schema:
$ref: '#/components/schemas/ids'
Expand Down Expand Up @@ -238,8 +237,7 @@ components:
ids:
type: array
description: |-
Array of Item ids to return. All other filter parameters that further
restrict the number of search results are ignored
Array of Item ids to return.
items:
type: string
datetimeFilter:
Expand Down