Skip to content

allow to update queryables #30

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.

Sign up for GitHub

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

Closed
wants to merge 3 commits into from
Closed

allow to update queryables #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
81dba36
allow to update queryables
thomas-maschler Jun 4, 2024
b3ed21e
changelog
thomas-maschler Jun 4, 2024
adfa75c
Update README.md
thomas-maschler Jun 14, 2024
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
7 changes: 7 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Added

- Allow to update Queryables


## [v1.0.0-rc.3] - 2023-10-18

### Added
Expand Down
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@
- Array Operators: `http://www.opengis.net/spec/cql2/1.0/conf/array-operators`
- Property-Property Comparisons: `http://www.opengis.net/spec/cql2/1.0/conf/property-property`
- Accent and Case-insensitive Comparison: `http://www.opengis.net/spec/cql2/1.0/conf/accent-case-insensitive-comparison`
- Queryables Transactions: `https://api.stacspec.org/v1.0.0/queryables/extensions/transaction`
- **Scope:** STAC API - Features, STAC API - Item Search
- **[Extension Maturity Classification](https://github.com/radiantearth/stac-api-spec/tree/main/README.md#maturity-classification):** Pilot
- **Dependencies:**
Expand Down Expand Up @@ -216,6 +217,8 @@ For additional capabilities, the following classes may be implemented:
Basic CQL2 conformance class only requires comparisons against right-hand-side literals.
- Accent and Case-insensitive Comparison: (`http://www.opengis.net/spec/cql2/1.0/conf/accent-case-insensitive-comparison`)
defines the UPPER and LOWER functions that can be used for case-insensitive comparison.
- Queryables Transactions: (`https://api.stacspec.org/v1.0.0/queryables/extensions/transaction`)
allow to update queryables properties on a per catalog and/or per collection basis.

Additionally, if an API implements the OGC API Features endpoint, it is **recommended** that the OAFeat Part 3 Filter,
Features Filter, and Basic CQL2 conformance classes be implemented, which allow use of CQL2 filters against the
Expand Down Expand Up @@ -366,6 +369,13 @@ in STAC API by the Filter Extension. In this case, the queryables endpoint (`/qu
}
```

### Updating Queryables

Implementers can choose to allow users to update default queryables on a per Catalog and/ or per Collection basis.
In that case, the `/queryables` endpoints should be callable using the `PUT` method with a payload containing the new queryables object. After updating the endpoint, a server-side process will have to ensure that the newly exposed fields can be queried for the Catalog or Collection or otherwise reject the request.

In addition to adding the PUT method to the queryables endpoint, implementers will also need to add the conformance class `https://api.stacspec.org/v1.0.0/queryables/extensions/transaction` to their API to advertise the added capabilities.

## GET Query Parameters and POST JSON fields

This extension adds three GET query parameters or POST JSON fields to an Item Search request:
Expand Down