Extension Maturity Classification: Proposal
A Collection extension to provide details about assets that are available in member Items.
This extension serves two purposes:
- Provide a human-readable definition of assets available in any Items belonging to this Collection so that the user can determine the key(s) of assets they are interested in.
- Provide a way to programmatically determine what assets are available in any member Item. Otherwise a random Item needs to be examined to determine assets available, but a random Item may not be representative of the set.
This extension introduces a single new field, assets at the top level of a collection.
An Asset Object defined at the Collection level is nearly the same as the Asset Object in Items, except for two differences.
The href field is not required, because collections don't point to any data by themselves.
Additioanlly the remaining fields, title and type are required in the Asset Definition, in order for it to adequately describe Item assets.
| Field Name | Type | Description |
|---|---|---|
| assets | Map<string, Asset Object> | REQUIRED. A dictionary of assets that can be found in member Items |
An asset is an object that contains details about the datafiles that will be included in member Items. Assets included at the Collection level do not imply that all assets are available from all Items. However, it is recommended that the Asset Definition is a complete set of all assets that may be available from any member Items.
| Field Name | Type | Description |
|---|---|---|
| title | string | REQUIRED. The displayed title for clients and users. This should provide enough information to a user to understand what the asset is |
| type | string | REQUIRED. Media type of the asset. |
Other custom fields, or fields from other extensions may also be included in the Asset object.
- AWS Public Dataset catalogs, landsat-8 and sentinel-2 define an Asset definition at the collection level.