Skip to content

Commit

Permalink
Extension naming: mixin -> single-item, mix -> item
Browse files Browse the repository at this point in the history
  • Loading branch information
m-mohr committed Oct 24, 2018
1 parent 6d8ffd8 commit 03a702d
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.

## [Unreleased]

- Added mixin extension
- Added Single Item extension
- Provider Object in collections: added a `description` field., renamed `type` to `roles`, change `roles` from string to array and added a `licensor` role.

## [v0.6.0-rc1] - 2018-10-16
Expand Down
12 changes: 6 additions & 6 deletions extensions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,12 @@ stable for over a year and are used in twenty or more implementations.

| Extension Name (Prefix) | Scope | Description | Maturity |
| ------------------------------------------------------------ | ---------------- | ------------------------------------------------------------ | -------- |
| [Commons](commons/README.md) (-) | Item +Collection | Provides a way to specify data fields in a collection that are common across the STAC Items in that collection, so that each does not need to repeat all the same information. | *Proposal* |
| [Datetime Range](datetime-range//README.md) (`dtr`) | Item | An extension to provide datetime ranges with a start and an end datetime stamp in a consistent way. | *Proposal* |
| [EO](eo//README.md) (`eo`) | Item | Covers electro-optical data that represents a snapshot of the earth for a single date and time. It could consist of multiple spectral bands, for example visible bands, infrared bands, red edge bands and panchromatic bands. The extension provides common fields like bands, cloud cover, off nadir, sun angle + elevation, gsd and more. | *Pilot* |
| [Mixin](mixin/README.md) (`mix`) | Item | Provides a way to specify several fields in Items that usually reside on the collection-level such as license and provider. | *Proposal* |
| [Scientific](scientific//README.md) (`sci`) | Item | Scientific metadata is considered to be data that indicate from which publication a collection originates and how the collection itself should be cited or referenced. | *Proposal* |
| [Transaction](transaction//README.md) | API | Provides an API extension to support the creation, editing, and deleting of items on a specific WFS3 collection. | *Pilot* |
| [Commons](commons/README.md) (-) | Item +Collection | Provides a way to specify data fields in a collection that are common across the STAC Items in that collection, so that each does not need to repeat all the same information. | *Proposal* |
| [Datetime Range](datetime-range//README.md) (`dtr`) | Item | An extension to provide datetime ranges with a start and an end datetime stamp in a consistent way. | *Proposal* |
| [EO](eo//README.md) (`eo`) | Item | Covers electro-optical data that represents a snapshot of the earth for a single date and time. It could consist of multiple spectral bands, for example visible bands, infrared bands, red edge bands and panchromatic bands. The extension provides common fields like bands, cloud cover, off nadir, sun angle + elevation, gsd and more. | *Pilot* |
| [Single Item](single-item/README.md) (`item`) | Item | Provides a way to specify several fields in individual Items that usually reside on the collection-level such as license and providers. | *Proposal* |
| [Scientific](scientific//README.md) (`sci`) | Item | Scientific metadata is considered to be data that indicate from which publication a collection originates and how the collection itself should be cited or referenced. | *Proposal* |
| [Transaction](transaction//README.md) | API | Provides an API extension to support the creation, editing, and deleting of items on a specific WFS3 collection. | *Pilot* |

## Third-party / vendor extensions

Expand Down
12 changes: 6 additions & 6 deletions extensions/mixin/README.md → extensions/single-item/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# Mixin Extension Specification (`mix`)
# SIngle Item Extension Specification (`item`)

**Extension [Maturity Classification](../README.md#extension-maturity): Proposal**

Provides a way to specify several fields in Items that usually reside on the collection-level such as license and provider.
Provides a way to specify several fields in individual Items that usually reside on the collection-level such as license and providers.

- [Example](example.json)
- [JSON Schema](schema.json)

## Item fields

| Field Name | Type | Description |
| ---------------- | ----------------- | ------------------------------------------------------------ |
| mix:license | string | Item's license(s) as a SPDX [License identifier](https://spdx.org/licenses/) or [expression](https://spdx.org/spdx-specification-21-web-version#h.jxpfx0ykyb60) or `proprietary` if the license is not on the SPDX license list. Proprietary licensed data SHOULD add a link to the license text, see the `license` relation type. |
| mix:providers | [Provider Object] | A list of providers, which may include all organizations capturing or processing the data or the hosting provider. Providers should be listed in chronological order with the most recent provider being the last element of the list. |
| Field Name | Type | Description |
| ----------------- | ----------------- | ------------------------------------------------------------ |
| item:license | string | Item's license(s) as a SPDX [License identifier](https://spdx.org/licenses/) or [expression](https://spdx.org/spdx-specification-21-web-version#h.jxpfx0ykyb60) or `proprietary` if the license is not on the SPDX license list. Proprietary licensed data SHOULD add a link to the license text, see the `license` relation type. |
| item:providers | [Provider Object] | A list of providers, which may include all organizations capturing or processing the data or the hosting provider. Providers should be listed in chronological order with the most recent provider being the last element of the list. |

### Provider Object

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@
},
"properties":{
"datetime":"2018-01-01T13:21:30Z",
"mix:license":"PDDL-1.0",
"mix:providers":[
"item:license":"PDDL-1.0",
"item:providers":[
{
"name":"John Doe",
"roles":[
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "schema.json#",
"type": "object",
"title": "Mixin Extension",
"title": "Single Item Extension",
"properties": {
"properties": {
"type": "object",
"properties": {
"mix:license": {
"item:license": {
"title": "Item Licenses",
"type": "string"
},
"mix:providers": {
"item:providers": {
"type": "array",
"items": {
"properties": {
Expand Down

0 comments on commit 03a702d

Please sign in to comment.