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

label:description/processing:lineage: Allow CommonMark #950 #998

Merged
merged 1 commit into from
Feb 22, 2021
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
- 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.
- `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))

### Removed

Expand Down
2 changes: 1 addition & 1 deletion extensions/label/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Some additional notes are given here for some of the core STAC Item fields and w
| ----------------- | -------------------------------- | -------------------------- | ----------- |
| label:properties | \[string]\|null | Name | **REQUIRED** These are the names of the property field(s) in each `Feature` of the label asset's `FeatureCollection` that contains the classes (keywords from `label:classes` if the property defines classes). If labels are rasters, use `null`. |
| label:classes | \[[Class Object](#class-object)] | Classes | **REQUIRED** if using categorical data. A Class Object defining the list of possible class names for each `label:properties`. (e.g., tree, building, car, hippo) |
| label:description | string | Description | **REQUIRED** A description of the label, how it was created, and what it is recommended for |
| label:description | string | Description | **REQUIRED** A description of the label, how it was created, and what it is recommended for. [CommonMark 0.29](https://commonmark.org/) syntax MAY be used for rich text representation. |
| label:type | string | Type | **REQUIRED** An ENUM of either `vector` label type or `raster` label type |
| label:tasks | \[string] | Task | Recommended to be a subset of 'regression', 'classification', 'detection', or 'segmentation', but may be an arbitrary value |
| label:methods | \[string] | Method | Recommended to be a subset of 'automated' or 'manual', but may be an arbitrary value. |
Expand Down
2 changes: 1 addition & 1 deletion extensions/processing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This extension applies to STAC Items and STAC Collections. As these processing i

| Field Name | Type | Description |
| ----------------------- | ------------------- | ----------- |
| processing:lineage | string | Lineage Information provided as free text information about the how observations were processed or models that were used to create the resource being described [NASA ISO](https://wiki.earthdata.nasa.gov/display/NASAISO/Lineage+Information). For example, `GRD Post Processing` for "GRD" product of Sentinel-1 satellites. |
| processing:lineage | string | Lineage Information provided as free text information about the how observations were processed or models that were used to create the resource being described [NASA ISO](https://wiki.earthdata.nasa.gov/display/NASAISO/Lineage+Information). For example, `GRD Post Processing` for "GRD" product of Sentinel-1 satellites. [CommonMark 0.29](https://commonmark.org/) syntax MAY be used for rich text representation. |
| processing:level | string | The name commonly used to refer to the processing level to make it easier to search for product level across collections or items. The short name must be used (only `L`, not `Level`). See the [list of suggested processing levels](#suggested-processing-levels). |
| processing:facility | string | The name of the facility that produced the data. For example, `Copernicus S1 Core Ground Segment - DPA` for product of Sentinel-1 satellites. |
| processing:software | Map<string, string> | A dictionary with name/version for key/value describing one or more softwares that produced the data. For example, `"Sentinel-1 IPF":"002.71"` for the software that produces Sentinel-1 satellites data. |
Expand Down