Skip to content
This repository was archived by the owner on Jul 23, 2025. It is now read-only.
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
12 changes: 9 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ 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-rc.2] - TBD

None

## [v1.0.0-rc.1] - 2022-03-17

None
Expand All @@ -28,7 +32,9 @@ None
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/radiantearth/stac-api-spec/compare/master...dev>
[v1.0.0-beta.1]: <https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-beta.1>
[v1.0.0-beta.4]: <https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-beta.4>

[Unreleased]: <https://github.com/stac-api-extensions/context/compare/v1.0.0-rc.2..main>
[v1.0.0-rc.2]: <https://github.com/stac-api-extensions/context/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.4]: <https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-beta.4>
[v1.0.0-beta.1]: <https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-beta.1>
23 changes: 12 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,20 @@

- **OpenAPI specification:** [openapi.yaml](openapi.yaml)
- **Conformance Classes:**
- **STAC API - Item Search** binding: <https://api.stacspec.org/v1.0.0-rc.1/item-search#context>
- **STAC API - Features** binding: <https://api.stacspec.org/v1.0.0-rc.1/ogcapi-features#context>
- **Extension [Maturity Classification](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.1/README.md#maturity-classification):** Candidate
- **STAC API - Item Search** binding: <https://api.stacspec.org/v1.0.0-rc.2/item-search#context>
- **STAC API - Features** binding: <https://api.stacspec.org/v1.0.0-rc.2/ogcapi-features#context>
- **Extension [Maturity Classification](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.2/README.md#maturity-classification):** Candidate
- **Dependencies:**
- [STAC API - Features](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.1/ogcapi-features)
- [STAC API - Item Search](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.1/item-search)
- [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-rc.2/item-search)

This extension is intended to augment the core [ItemCollection](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.1/itemcollection/README.md)
This extension is intended to augment the core [ItemCollection](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.2/itemcollection/README.md)
object when the ItemCollection is the result of a search, for example, from calling the `/search` API endpoint.

This fragment may be bound to either or both of
[STAC API - Item Search](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.1/item-search) (`/search` endpoint) or
[STAC API - Features](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.1/ogcapi-features) (`/collections/{collectionId}/items` endpoint) by
[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)
(`/collections/{collectionId}/items` endpoint) by
advertising the relevant conformance class.

**Note**: OGC API Features - Part 1 has its own way returning `numberMatched` and `numberReturned` at the top level, instead of in a context
Expand All @@ -26,9 +27,9 @@ is required to implement both when implementing STAC Features.

## ItemCollection fields

| Element | Type | Description |
| --------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `context` | [Context Object](#context-object) | **REQUIRED.** The search-related metadata for the [ItemCollection](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.1/itemcollection/README.md). |
| Element | Type | Description |
| --------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `context` | [Context Object](#context-object) | **REQUIRED.** The search-related metadata for the [ItemCollection](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.2/itemcollection/README.md). |

## Context Object

Expand Down
2 changes: 1 addition & 1 deletion openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ openapi: 3.0.3
info:
title: The SpatioTemporal Asset Catalog API - Context Extension
description: Adds search related metadata (context) to responses.
version: 1.0.0-rc.1
version: 1.0.0-rc.2
contact:
name: STAC Specification
url: 'http://stacspec.org'
Expand Down
6 changes: 3 additions & 3 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "stac-api-context-extension-spec",
"version": "1.0.0-rc.1",
"version": "1.0.0-rc.2",
"description": "STAC API helpers to generate, serve and check the API spec.",
"repository": "https://github.com/stac-api-extensions/context",
"license": "Apache-2.0",
Expand Down Expand Up @@ -86,4 +86,4 @@
]
]
}
}
}