From 7fece156f36bfb42cd1b31da111ab83420930bd1 Mon Sep 17 00:00:00 2001 From: Matthias Mohr Date: Tue, 12 Mar 2024 17:34:43 +0100 Subject: [PATCH 1/3] Update version number --- CHANGELOG.md | 5 ++++- README.md | 2 +- examples/collection.json | 2 +- examples/item.json | 2 +- json-schema/schema.json | 4 ++-- package.json | 4 ++-- 6 files changed, 11 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5f3be54..9b51ed8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [v1.2.0] - 2023-03-15 + ### Added - Added a new field `name` to the Alternate Asset Object @@ -35,6 +37,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 Initial release -[Unreleased]: +[Unreleased]: +[v1.2.0]: [v1.1.0]: [v1.0.0]: diff --git a/README.md b/README.md index 34201cd..45f6093 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Alternate Assets Extension Specification - **Title:** Alternate Assets -- **Identifier:** +- **Identifier:** - **Field Name Prefix:** - - **Scope:** Item, Collection - **Extension [Maturity Classification](https://github.com/radiantearth/stac-spec/tree/master/extensions/README.md#extension-maturity):** Pilot diff --git a/examples/collection.json b/examples/collection.json index c8d600b..31f061e 100644 --- a/examples/collection.json +++ b/examples/collection.json @@ -2,7 +2,7 @@ "stac_version": "1.0.0", "stac_extensions": [ "https://stac-extensions.github.io/item-assets/v1.0.0/schema.json", - "https://stac-extensions.github.io/alternate-assets/v1.1.0/schema.json" + "https://stac-extensions.github.io/alternate-assets/v1.2.0/schema.json" ], "type": "Collection", "id": "collection-1", diff --git a/examples/item.json b/examples/item.json index 7811c7e..90090e7 100644 --- a/examples/item.json +++ b/examples/item.json @@ -1,7 +1,7 @@ { "stac_version": "1.0.0", "stac_extensions": [ - "https://stac-extensions.github.io/alternate-assets/v1.1.0/schema.json" + "https://stac-extensions.github.io/alternate-assets/v1.2.0/schema.json" ], "type": "Feature", "id": "item", diff --git a/json-schema/schema.json b/json-schema/schema.json index c577230..ea2a785 100644 --- a/json-schema/schema.json +++ b/json-schema/schema.json @@ -1,6 +1,6 @@ { "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "https://stac-extensions.github.io/alternate-assets/v1.1.0/schema.json#", + "$id": "https://stac-extensions.github.io/alternate-assets/v1.2.0/schema.json#", "title": "Alternate Assets Extension", "description": "STAC Alternate Assets Extension for STAC Items and STAC Collections.", "type": "object", @@ -9,7 +9,7 @@ "stac_extensions": { "type": "array", "contains": { - "const": "https://stac-extensions.github.io/alternate-assets/v1.1.0/schema.json" + "const": "https://stac-extensions.github.io/alternate-assets/v1.2.0/schema.json" } } }, diff --git a/package.json b/package.json index 1595844..9322c47 100644 --- a/package.json +++ b/package.json @@ -4,8 +4,8 @@ "scripts": { "test": "npm run check-markdown && npm run check-examples", "check-markdown": "remark . -f -r .github/remark.yaml", - "check-examples": "stac-node-validator . --lint --verbose --schemaMap https://stac-extensions.github.io/alternate-assets/v1.1.0/schema.json=./json-schema/schema.json", - "format-examples": "stac-node-validator . --format --schemaMap https://stac-extensions.github.io/alternate-assets/v1.1.0/schema.json=./json-schema/schema.json" + "check-examples": "stac-node-validator . --lint --verbose --schemaMap https://stac-extensions.github.io/alternate-assets/v1.2.0/schema.json=./json-schema/schema.json", + "format-examples": "stac-node-validator . --format --schemaMap https://stac-extensions.github.io/alternate-assets/v1.2.0/schema.json=./json-schema/schema.json" }, "dependencies": { "remark-cli": "^8.0.0", From b915c6d9ca3c2494356adb0bcaaa0a9f458ec258 Mon Sep 17 00:00:00 2001 From: Matthias Mohr Date: Tue, 9 Jul 2024 22:03:01 +0200 Subject: [PATCH 2/3] Avoid conflicts with the name from bands etc. --- README.md | 22 +++++++++++----------- examples/collection.json | 10 +++++----- examples/item.json | 4 ++-- json-schema/schema.json | 8 ++++---- 4 files changed, 22 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 45f6093..553dfca 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ - **Title:** Alternate Assets - **Identifier:** -- **Field Name Prefix:** - +- **Field Name Prefix:** `alternate` - **Scope:** Item, Collection - **Extension [Maturity Classification](https://github.com/radiantearth/stac-spec/tree/master/extensions/README.md#extension-maturity):** Pilot - **Owner**: @matthewhanson @@ -30,10 +30,10 @@ The fields in the table below can be used in these parts of STAC documents: - [x] Assets (for both Collections and Items, incl. Item Asset Definitions in Collections) - [ ] Links -| Field Name | Type | Description | -| ---------- | -------------------------------------------------------------- | ----------- | -| alternate | Map | An array of alternate location information for an asset | -| name | string | A short name to distinguish the asset from the alternate assets. | +| Field Name | Type | Description | +| -------------- | -------------------------------------------------------------- | ----------- | +| alternate | Map | An array of alternate location information for an asset | +| alternate:name | string | A short name to distinguish the asset from the alternate assets. | Each alternate asset consists of a key and an Alternate Asset Object. @@ -55,14 +55,14 @@ In other words, if all the assets in an Item are all available via s3 direct acc ### Alternate Asset Object -The Alternate Asset Object are similar to the core Asset object, except only contain fields relevant to the location and access of the asset. +The Alternate Asset Object are similar to the core Asset object, except only contain fields relevant to the location and access of the asset. -| Field Name | Type | Description | -| ----------- | ------ | ----------- | -| href | string | **REQUIRED.** URI to the asset object. Relative and absolute URI are both allowed. | -| name | string | A short name to distinguish the alternate assets. | +| Field Name | Type | Description | +| -------------- | ------ | ----------- | +| href | string | **REQUIRED.** URI to the asset object. Relative and absolute URI are both allowed. | +| alternate:name | string | A short name to distinguish the alternate assets. | -In the simplest case, the object consists of a single `href` field, but could include additional details regarding the alternate location or URL. +In the simplest case, the object consists of a single `href` field, but could include additional details regarding the alternate location or URL. Some fields that are commonly provided: diff --git a/examples/collection.json b/examples/collection.json index 31f061e..1144d2b 100644 --- a/examples/collection.json +++ b/examples/collection.json @@ -37,15 +37,15 @@ "roles": [ "archive" ], - "name": "Example Corp. HTTPS", + "alternate:name": "Example Corp. HTTPS", "alternate": { "s3": { "href": "s3://mycoolsat-bucket/collection/items.zip", - "name": "Amazon S3" + "alternate:name": "Amazon S3" }, "source": { "href": "https://source.coop/example/collection/items.zip", - "name": "Source.coop HTTPS" + "alternate:name": "Source.coop HTTPS" } } } @@ -56,10 +56,10 @@ "roles": [ "data" ], - "name": "HTTPS", + "alternate:name": "HTTPS", "alternate": { "s3": { - "name": "S3", + "alternate:name": "S3", "description": "Access the files via regular Amazon AWS S3 tooling." } } diff --git a/examples/item.json b/examples/item.json index 90090e7..41959be 100644 --- a/examples/item.json +++ b/examples/item.json @@ -60,11 +60,11 @@ "roles": [ "data" ], - "name": "HTTPS", + "alternate:name": "HTTPS", "alternate": { "s3": { "href": "s3://mycoolsat-bucket/examples/file.tif", - "name": "S3", + "alternate:name": "S3", "description": "Access the files via regular Amazon AWS S3 tooling." } } diff --git a/json-schema/schema.json b/json-schema/schema.json index ea2a785..e1c2697 100644 --- a/json-schema/schema.json +++ b/json-schema/schema.json @@ -25,7 +25,7 @@ "assets": { "type": "object", "properties": { - "name": { + "alternate:name": { "$ref": "#/definitions/name" }, "alternate": { @@ -50,7 +50,7 @@ "type": "object", "additionalProperties": { "properties": { - "name": { + "alternate:name": { "$ref": "#/definitions/name" }, "alternate": { @@ -70,7 +70,7 @@ "object_without_href": { "type": "object", "properties": { - "name": { + "alternate:name": { "$ref": "#/definitions/name" } }, @@ -85,7 +85,7 @@ "additionalProperties": { "type": "object", "properties": { - "name": { + "alternate:name": { "$ref": "#/definitions/name" }, "alternate": { From 195c6267f0a1bc3374be90fc3ebb7205f26d54e5 Mon Sep 17 00:00:00 2001 From: Matthias Mohr Date: Tue, 9 Jul 2024 22:03:59 +0200 Subject: [PATCH 3/3] Merge pull request #14 from stac-extensions/m-mohr-patch-1 Clarify what an alternate asset it #13 --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9b51ed8..fd1201f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,7 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added -- Added a new field `name` to the Alternate Asset Object +- Added a new field `alternate:name` to the Asset Object and Alternate Asset Object ### Changed