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

link clean-up #49

Merged
merged 1 commit into from
Nov 2, 2020
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
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@ The SpatioTemporal Asset Catalog (STAC) specification aims to standardize the wa
A 'spatiotemporal asset' is any file that represents information about the earth captured in a certain space and
time. The core STAC specification lives at [gitub.com/radiantearth/stac-spec](https://github.com/radiantearth/stac-spec).

A STAC API is the dynamic version of a SpatioTemporal Asset Catalog. It returns a STAC [Catalog](./stac-spec/catalog-spec/catalog-spec.md),
[Collection](./stac-spec/collection-spec/collection-spec.md), [Item](./stac-spec/item-spec/item-spec.md),
or [ItemCollection](./stac-spec/item-spec/itemcollection-spec.md), depending on the endpoint.
A STAC API is the dynamic version of a SpatioTemporal Asset Catalog. It returns a STAC [Catalog](https://github.com/radiantearth/stac-spec/catalog-spec/catalog-spec.md),
[Collection](https://github.com/radiantearth/stac-spec/collection-spec/collection-spec.md), [Item](https://github.com/radiantearth/stac-spec/item-spec/item-spec.md),
or [ItemCollection](https://github.com/radiantearth/stac-spec/item-spec/itemcollection-spec.md), depending on the endpoint.
Catalogs and Collections are JSON, while Items and ItemCollections are GeoJSON-compliant entities with foreign members.
Typically, a Feature is used when returning a single Item, and FeatureCollection when multiple Items (rather than a JSON array of Item entities).

The API is compliant with the *[OGC API - Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html)* standard
(formerly known as *OGC Web Feature Service 3*), in that it defines many of the endpoints that STAC uses. A STAC API should be
compatible and usable with any OGC API - Features clients. The STAC API can be thought of as a specialized Features API
to search STAC Catalogs, where the features returned are STAC [Items](./stac-spec/item-spec/item-spec.md),
to search STAC Catalogs, where the features returned are STAC [Items](https://github.com/radiantearth/stac-spec/item-spec/item-spec.md),
that have common properties, links to their assets and geometries that represent the footprints of the geospatial assets.

## WARNING
Expand Down
12 changes: 6 additions & 6 deletions api-spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ OGC Web Feature Service (WFS). Future STAC API releases will align with

The OGC API - Features is a standard API that represents collections of geospatial data. It defines the RESTful interface
to query geospatial data, with GeoJSON as a main return type. With OAFeat you can return any `Feature`, which is a geometry
plus any number of properties. The core [STAC Item spec](./stac-spec/item-spec/README.md)
plus any number of properties. The core [STAC Item spec](https://github.com/radiantearth/stac-spec/item-spec/README.md)
enhances the core `Feature` with additional requirements and options to enable cataloging of spatiotemporal 'assets' like
satellite imagery. This STAC `Item` always links to an asset, and these assets always have a capture time, so it requires
fields for `datetime` and `assets`. The STAC API extends the OAFeat core with some key functionality to enable search of
Expand All @@ -16,14 +16,14 @@ geospatial assets, detailed below.
OAFeat also defines the concept of a Collection, which contains Features. In OAFeat Collections are the sets of data that can
be queried ([7.11](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html#_collections_)), and each describes basic
information about the geospatial dataset, like its name and description, as well as the spatial and temporal extents of all
the data contained. [STAC collections](./stac-spec/collection-spec/README.md) contain this same
the data contained. [STAC collections](https://github.com/radiantearth/stac-spec/collection-spec/README.md) contain this same
information, along with other STAC specific fields to provide additional metadata for searching spatiotemporal assets, and
thus are compliant with both OAFeat Collections and STAC Collections and are returned from the `/collections/{collection_id}`
endpoint.

In OAFeat Features are the individual records within a Collection and are provided in GeoJSON format.
[STAC Items](./stac-spec/item-spec/README.md) are analogous to OAFeat Features, are in GeoJSON, and are returned from the
`/collections/{collection_id}/items/{item_id}` endpoint.
[STAC Items](https://github.com/radiantearth/stac-spec/item-spec/README.md) are analogous to OAFeat Features,
are in GeoJSON, and are returned from the `/collections/{collection_id}/items/{item_id}` endpoint.

A typical OAFeat will have multiple collections, and each will just offer simple search for its particular collection at
`GET /collections/{collectionId}/items`.
Expand Down Expand Up @@ -104,8 +104,8 @@ See the [OpenAPI specification document](openapi/STAC.yaml).

| Endpoint | Returns | Description |
| -------- | -------------------------------------------------------------- | ----------- |
| `/` | [Catalog](./stac-spec/catalog-spec/catalog-spec.md) | Extends `/` from OAFeat to return a full STAC catalog. |
| `/search` | [ItemCollection](./stac-spec/item-spec/itemcollection-spec.md) | Retrieves a group of Items matching the provided search predicates, probably containing search metadata from the `search` extension |
| `/` | [Catalog](https://github.com/radiantearth/stac-spec/catalog-spec/catalog-spec.md) | Extends `/` from OAFeat to return a full STAC catalog. |
| `/search` | [ItemCollection](https://github.com/radiantearth/stac-spec/item-spec/itemcollection-spec.md) | Retrieves a group of Items matching the provided search predicates, probably containing search metadata from the `search` extension |

The root endpoint (`/`) is most useful when it presents a complete `Catalog` representation of all the data contained in the API, such that all `Collections` and `Items` can be navigated to by transitively traversing links from this root. This spec does not require any API endpoints from OAFeat or STAC API to be implemented, so these links may not exist if the endpoint has not been implemented.

Expand Down
2 changes: 1 addition & 1 deletion principles.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ for data in a different projection.
- **Working code required.** Proposed changes should be accompanied by working code
(ideally with a link to an online service running the code). A reference implementation should be available
online to power the interactive documentation. Fully accepted specifications should have at least 3 implementations
that cover the entire specification. Extensions have their own[Extention Maturity](./stac-spec/extensions/README.md#extension-maturity) model.
that cover the entire specification. Extensions have their own [Extention Maturity](extensions/README.md#extension-maturity) model.

- **Design for scale.** The design should work great with more data than can be imagined right now.
Ideally implementations are built with large test data sets to validate that they will work.
Expand Down