Skip to content

Commit

Permalink
Add federation:description
Browse files Browse the repository at this point in the history
  • Loading branch information
m-mohr committed Oct 28, 2021
1 parent 42e963b commit ce41e2d
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion extensions/federation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,16 @@ schema:
items:
type: string
description: The ID of a back-end.
'federation:description':
description: |-
Allows back-ends to provide backend-specific details about this resource in a human-readable way.
[CommonMark 0.29](http://commonmark.org/) syntax MAY be used for rich text representation.
type: array
minItems: 1
items:
type: string
description: The ID of a back-end.
```
**Note:** In Collections this should be placed inside `summaries` if users should be able to filter on back-ends in `load_collection`.
Expand All @@ -162,7 +172,7 @@ schema:
{
"name": "proprietary_parameter",
"description": "A parameter supported only by EODC.",
"federation:hosted": ["eodc"],
"federation:backends": ["eodc"],
"schema": {}
}
]
Expand All @@ -177,6 +187,10 @@ schema:
"stac_version": "1.0.0",
"id": "example",
"description": "...",
"federation:description": {
"eodc": "The collection contains data for Austria only.",
"vito": "The collection contains data for Belgium only.",
},
"summaries": {
"federation:backends": ["vito", "eodc"],
...
Expand Down

0 comments on commit ce41e2d

Please sign in to comment.