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

prepare for 1.0.0 release #9

Merged
merged 2 commits into from
Sep 28, 2023
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
3 changes: 2 additions & 1 deletion .remarkignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
/CHANGELOG.md
/CHANGELOG.md
.github/pull_request_template.md
11 changes: 9 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
# Changelog

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).

## [v1.0.0] - 2023-09-28

### Changed

- Updated maturity to Stable.

## [v1.0.0-rc.2] - TBD
## [v1.0.0-rc.2] - 2022-11-01

### Fixed

Expand Down Expand Up @@ -206,7 +212,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
See the [stac-spec CHANGELOG](https://github.com/radiantearth/stac-spec/blob/v0.9.0/CHANGELOG.md)
for STAC API releases prior to or equal to version 0.9.0.

[Unreleased]: <https://github.com/stac-api-extensions/sort/compare/v1.0.0-rc.2..main>
[Unreleased]: <https://github.com/stac-api-extensions/sort/compare/v1.0.0..main>
[v1.0.0]: <https://github.com/stac-api-extensions/sort/tree/v1.0.0>
[v1.0.0-rc.2]: <https://github.com/stac-api-extensions/sort/tree/v1.0.0-rc.2>
[v1.0.0-rc.1]: <https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.1>
[v1.0.0-beta.5]: <https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-beta.5>
Expand Down
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@

- [STAC API - Sort Extension Specification](#stac-api---sort-extension-specification)
- [Overview](#overview)
- [HTTP GET (or POST Form)](#http-get-or-post-form)
- [HTTP GET](#http-get)
- [HTTP POST JSON Entity](#http-post-json-entity)

## Overview

- **Title:** Sort
- **OpenAPI specification:** [openapi.yaml](openapi.yaml)
- **Conformance Classes:**
- **STAC API - Item Search** binding: <https://api.stacspec.org/v1.0.0-rc.2/item-search#sort>
- **STAC API - Features** binding: <https://api.stacspec.org/v1.0.0-rc.2/ogcapi-features#sort>
- **STAC API - Item Search** binding: <https://api.stacspec.org/v1.0.0/item-search#sort>
- **STAC API - Features** binding: <https://api.stacspec.org/v1.0.0/ogcapi-features#sort>
- **Scope:** STAC API - Features, STAC API - Item Search
- **[Extension Maturity Classification](https://github.com/radiantearth/stac-api-spec/tree/main/README.md#maturity-classification):** Candidate
- **[Extension Maturity Classification](https://github.com/radiantearth/stac-api-spec/tree/main/README.md#maturity-classification):** Stable
- **Dependencies:**
- [STAC API - Item Search](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.2/item-search)
- [STAC API - Features](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.2/item-search)
- [STAC API - Item Search](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0/item-search)
- [STAC API - Features](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0/item-search)
- **Owner**: @philvarner

This specification defines a new parameter, `sortby`, that allows the user to define the fields by which
Expand All @@ -34,8 +34,8 @@ fields in Item Properties to be prefixed with `properties.` or not, or support u
name, e.g., `properties.datetime` or `datetime`.

Sort behavior may be bound to either or both of
[STAC API - Item Search](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.2/item-search) (`/search` endpoint) or
[STAC API - Features](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.2/ogcapi-features)
[STAC API - Item Search](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0/item-search) (`/search` endpoint) or
[STAC API - Features](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0/ogcapi-features)
(`/collections/{collectionId}/items` endpoint) by advertising the relevant conformance class.

Fields may be sorted in ascending or descending order. The syntax between GET requests and POST requests with a JSON
Expand All @@ -46,12 +46,12 @@ the data in the order provided (e.g., first by `datetime`, then by `eo:cloud_cov
worked on as part of OGC API - Records, see [this issue](https://github.com/opengeospatial/ogcapi-records/issues/22)
for the latest discussion.*

## HTTP GET (or POST Form)
## HTTP GET

When calling a relevant endpoint using GET (or POST with `Content-Type: application/x-www-form-urlencoded` or
`Content-Type: multipart/form-data)`, a single parameter `sortby` with a comma-separated list of item field names must
When calling a relevant endpoint using GET, a single parameter `sortby` with a comma-separated list of item field names must
be provided. The field names may be prefixed with either "+" for ascending, or "-" for descending. If no sign is
provided before the field name, it will be assumed to be "+".
provided before the field name, it will be assumed to be "+". Note that `+` is used commonly
by URL encoding as a space, so some tools may require escaping this literal `+` with a URL encoding of `%2B`.

Examples of `sortby` parameter:

Expand Down
Loading