Skip to content

Commit 8ba3d5d

Browse files
authored
Add description field #3 (#4)
1 parent fb288f3 commit 8ba3d5d

File tree

4 files changed

+9
-0
lines changed

4 files changed

+9
-0
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
99
### Added
1010

1111
- The country can be an ISO 3166-1 country code
12+
- New field `description`
1213

1314
### Changed
1415

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ which itself is inspired by [ISO 19115](https://www.iso.org/standard/53798.html)
2020
## Fields
2121

2222
The fields in the table below can be used in these parts of STAC documents:
23+
2324
- [x] Catalogs
2425
- [x] Collections
2526
- [x] Item Properties (incl. Summaries in Collections)
@@ -41,6 +42,7 @@ Either the field `name` or the field `organization` must be provided (or both).
4142
| organization | string | **REQUIRED if `name` is missing**.Organization/affiliation of the contact. |
4243
| identifier | string | A value uniquely identifying a contact. |
4344
| position | string | The name of the role or position of the responsible person taken from the organization's formal organizational hierarchy or chart. |
45+
| description | string | Detailed multi-line description to fully explain the STAC entity. [CommonMark 0.29](https://commonmark.org/) syntax MAY be used for rich text representation. |
4446
| logo | [Link Object](#link-object) | Graphic identifying a contact. The link relation must be `icon` and the media type must be an image media type. |
4547
| phones | \[[Info Object](#info-object)] | Telephone numbers at which contact can be made. |
4648
| emails | \[[Info Object](#info-object)] | Email address at which contact can be made. |

examples/collection.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
{
1313
"name": "John Doe",
1414
"position": "CEO",
15+
"description": "John Doe is the CEO of Doe Chemicals, overseeing all operations and strategic direction.",
1516
"organization": "Doe Chemicals",
1617
"logo": {
1718
"href": "https://doe.com/images/logo.png",
@@ -62,6 +63,7 @@
6263
},
6364
{
6465
"organization": "Doe Chemicals - Support Team",
66+
"name": "English and German speaking support available",
6567
"logo": {
6668
"href": "https://doe.com/images/logo.png",
6769
"rel": "icon",

json-schema/schema.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,10 @@
117117
"organization": {
118118
"type": "string"
119119
},
120+
"description": {
121+
"type": "string",
122+
"minLength": 1
123+
},
120124
"logo": {
121125
"allOf": [
122126
{

0 commit comments

Comments
 (0)