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

Examples refresh #955

Merged
merged 50 commits into from
Feb 24, 2021
Merged
Show file tree
Hide file tree
Changes from 40 commits
Commits
Show all changes
50 commits
Select commit Hold shift + click to select a range
ea3262c
removed extra examples. They will move to http://github.com/stac-util…
cholmes Jan 27, 2021
ffedc29
first cut at combined example folder
cholmes Jan 27, 2021
e335e70
link updates
cholmes Jan 27, 2021
723a422
updated link
cholmes Jan 27, 2021
2cc1fac
started readme
cholmes Jan 27, 2021
c6cea9f
validation fixes
cholmes Jan 29, 2021
83cf4da
further refinement
cholmes Jan 29, 2021
c68014a
more organization
cholmes Jan 29, 2021
1befd10
more fixes
cholmes Jan 29, 2021
b71f356
fixes
cholmes Jan 29, 2021
d8a5b65
updated for best practices
cholmes Jan 29, 2021
89391bc
clean-up, moved to best practice
cholmes Jan 29, 2021
962f17e
updated links
cholmes Jan 29, 2021
a7f1d08
filling out the readme
cholmes Feb 7, 2021
e10014f
link fixes
cholmes Feb 7, 2021
dfcf88a
update for absolute self link
cholmes Feb 7, 2021
4d1ca91
removed custom stac media type
cholmes Feb 7, 2021
8db37e9
expanding readme
cholmes Feb 7, 2021
018e4d1
readme updates
cholmes Feb 8, 2021
7fdf89b
updates for working simple-item
cholmes Feb 8, 2021
f4c5927
fixing links, refining
cholmes Feb 8, 2021
1f1023e
added proper shape/transform info
cholmes Feb 8, 2021
ee0d37c
formatting and reworking
cholmes Feb 9, 2021
e03848e
cleanup from dev merge
cholmes Feb 9, 2021
24362d2
formatting and changelog
cholmes Feb 9, 2021
87a3794
fully fixed examples (hopefully)
cholmes Feb 9, 2021
f365a61
got rid of (hopefully) all stac specific media types
cholmes Feb 17, 2021
ab9964e
added proper stac_extensions field
cholmes Feb 17, 2021
551bd5e
got rid of extra collection
cholmes Feb 17, 2021
2c601dd
moved extension examples back to extensions
cholmes Feb 17, 2021
1483a47
Update examples/README.md
cholmes Feb 22, 2021
c44075f
cleanup formatting
cholmes Feb 22, 2021
167cfc6
Merge branch 'dev' into examples-refresh
cholmes Feb 22, 2021
630b267
example cleanup
cholmes Feb 22, 2021
3bc6a9f
Merge branch 'examples-refresh' of github.com:radiantearth/stac-spec …
cholmes Feb 22, 2021
6e98d9d
formatting fixes
cholmes Feb 22, 2021
5fa7b9c
Merge remote-tracking branch 'origin/fix-eo-example' into examples-re…
m-mohr Feb 22, 2021
d8a8ea1
updated id
cholmes Feb 22, 2021
b6c42d2
Merge branch 'examples-refresh' of github.com:radiantearth/stac-spec …
cholmes Feb 22, 2021
63616e7
updates from comments
cholmes Feb 23, 2021
b4dd5c1
clarified self-contained definitions, explained how examples follow them
cholmes Feb 23, 2021
b85d0eb
clarified self-contained definitions, explained how examples follow them
cholmes Feb 23, 2021
bb8a642
Merge branch 'dev' into examples-refresh
cholmes Feb 23, 2021
88fc08c
updated to be a true relative published catalog, updated self to be f…
cholmes Feb 23, 2021
2d821be
Merge branch 'examples-refresh' of github.com:radiantearth/stac-spec …
cholmes Feb 23, 2021
14ab2c2
fixes for the latest changes to examples
cholmes Feb 24, 2021
9532447
restored examples
cholmes Feb 24, 2021
6d8951b
Merge branch 'dev' into examples-refresh
cholmes Feb 24, 2021
7094b82
readded
cholmes Feb 24, 2021
66ba01a
fixed merge conflict
cholmes Feb 24, 2021
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 @@ -24,6 +24,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
- URIs (usually found int properties like `href`, `url`) are now validated using the `iri-reference` format in JSON Schema (allows international characters in URIs)
- Relaxed the regular expression for DOIs in the scientific extension ([#910](https://github.com/radiantearth/stac-spec/issues/910))
- The [Stats Object](collection-spec/collection-spec.md#stats-object) for Collection `summaries` changed `min` to `minimum` and `max` to `maximum` to align with JSON Schema.
- Moved examples from individual directories into a single /examples folder at the root, and evolved them to be more representative.
- `proj:geometry` allows all GeoJSON geometries instead of just a polygon.
- `label:description` and `processing:lineage` allow CommonMark for rich-text representation ([#950](https://github.com/radiantearth/stac-spec/issues/950))

Expand Down
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ the specification takes place in the [issue tracker](https://github.com/radiante

## In this Repository

This repository contains the core specifications plus examples and validation schemas. Also included are a
This repository contains the core specifications plus [examples](examples/) and validation schemas. Also included are a
few documents that provide more context and plans for the evolution of the specification. Each spec folder contains a
README explaining the layout of the folder, the main specification document, examples, and validating schemas. And
there is one more specification in the STAC 'family', which is
Expand All @@ -68,6 +68,9 @@ In the context of STAC it is most likely a collection of STAC Items that is made
It includes things like the spatial and temporal extent of the data, the license, keywords, etc.
It enables discovery at a higher level than individual items, providing a simple way to describe sets of data.

**Examples:** The *[examples/](examples)* folder contains examples for all three specifications, linked together to form two
complete examples. Each spec and extension links in to highlight particular files that demonstrate key concepts.

**Extensions:** The *[extensions/](extensions/)* folder is where extensions live. Extensions can extend the
functionality of the core spec or add fields for specific domains. Each extension has at least one *owner*. You can find extension owners in each extension's README or in the [`CODEOWNERS`](.github/CODEOWNERS) file.

Expand Down
3 changes: 0 additions & 3 deletions catalog-spec/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,6 @@ specification contains an OpenAPI definition of the standard way to do this, at
**The Specification:** The main Catalog specification is in *[catalog-spec.md](catalog-spec.md)*.
It includes in depth explanation of the structures and fields.

**Examples:** For samples of how Catalogs can be implemented the *[examples/](examples/)* folder
contains a full sample catalog.

**Schemas:** The schemas to validate the core Catalog definition are found in the *[json-schema/](json-schema/)* folder.
The primary one is *[catalog.json](json-schema/catalog.json)*.

Expand Down
6 changes: 3 additions & 3 deletions catalog-spec/catalog-spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ Catalogs are not intended to be queried. Their purpose is discovery: to be brows
by machines to build a search index. A Catalog can be represented in JSON format. Any JSON object
that contains all the required fields is a valid STAC Catalog.

- [Examples](examples/)
- See a [minimal example](examples/catalog.json), as well a [fuller example](examples/catalog-items.json)
includes links to several items.
- [Examples](../examples/)
- See an example [catalog.json](../examples/catalog.json). The [collection.json](../examples/collection.json) is also a valid
catalog file, demonstrating linking to items (it is also a collection, so has additional fields)
- [JSON Schema](json-schema/catalog.json)

The [Catalog section of the Overview](../overview.md#catalog-overview) document provides background information on
Expand Down
45 changes: 0 additions & 45 deletions catalog-spec/examples/catalog-items.json

This file was deleted.

19 changes: 0 additions & 19 deletions catalog-spec/examples/catalog.json

This file was deleted.

4 changes: 1 addition & 3 deletions collection-spec/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ properties and share higher level metadata. Others called it: dataset series (ES
**The Specification:** The main STAC Collection specification is in *[collection-spec.md](collection-spec.md)*. It includes an overview and in depth explanation of the
structures and fields.

**Examples:** For samples of how Collections can be implemented the *[examples/](examples/)* folder contains a sample collection.

**Schemas:** The schemas to validate the STAC Collection definition are found in the
*[json-schema/](json-schema/)* folder. The primary one is *[collection.json](json-schema/collection.json)*.

Expand All @@ -30,7 +28,7 @@ structures and fields.
STAC Collections are defined for flexibility. They only require a handful of fields, and
implementors are free to add most any JSON field or object that they want via extensions. This flexibility and extensibility is a design goal, so that it is quite easy to implement a collection and be able to adapt it to most any data model.

But it is expected that some more firm recommendations and even requirements will emerge, so that clients will be able to glean more meaningful information. In the meantime implementors are encouraged to do what makes sense for them, and to check out the [examples](examples/) and [other implementations](https://stacspec.org/#examples) for emerging best practices.
Implementors are encouraged to do what makes sense for them, and to check out the [examples](../examples/) and [other implementations](https://stacindex.org/catalogs) for current best practices.

## Collection Evolution

Expand Down
8 changes: 5 additions & 3 deletions collection-spec/collection-spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@ A STAC Collection can be represented in JSON format. Any JSON object that contai

STAC Collections are meant to be compatible with *OGC API - Features* Collections, but please be aware that OAFeat Collections and STAC Collections originate from different specifications and despite the fact that we try to align them as much as possible be there may be subtle differences in the specifications.

* [Examples](examples/):
* Sentinel 2: A basic standalone example of a [Collection](examples/sentinel2.json) without items.
* Landsat 8: A [Collection](examples/landsat-collection.json) with corresponding Item [Item](../item-spec/examples/landsat8-sample.json).
* [Examples](../examples/):
* Sentinel 2: A basic standalone example of a [Collection](../examples/collection-only/collection.json) without items.
* Simple Example: A [Collection](../examples/collection.json) that links to 3 example items.
* Extension Collection: An additional [Collection](../examples/extensions-collection/collection.json), which is used to highlight
various [extension](../extensions) functionality, but serves as another example.
* [JSON Schema](json-schema/collection.json)

## Collection fields
Expand Down
160 changes: 0 additions & 160 deletions collection-spec/examples/landsat-collection.json

This file was deleted.

Loading