From 4fb2f0f680d638dcee95a93cd927ad333786e44c Mon Sep 17 00:00:00 2001 From: Matthias Mohr Date: Fri, 19 Feb 2021 15:31:46 +0100 Subject: [PATCH] label:description/processing:lineage: Allow CommonMark #950 --- CHANGELOG.md | 1 + extensions/label/README.md | 2 +- extensions/processing/README.md | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 945bbef03..f8132421c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/extensions/label/README.md b/extensions/label/README.md index dcbc5b013..0c22e9347 100644 --- a/extensions/label/README.md +++ b/extensions/label/README.md @@ -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. | diff --git a/extensions/processing/README.md b/extensions/processing/README.md index 687f0b1cf..0ee1b0dd2 100644 --- a/extensions/processing/README.md +++ b/extensions/processing/README.md @@ -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 | 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. |