Skip to content

Commit

Permalink
removal of proj:epsg and v2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
m-mohr committed Jul 22, 2024
1 parent 51d88bc commit 730c0b6
Show file tree
Hide file tree
Showing 8 changed files with 26 additions and 45 deletions.
10 changes: 9 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [v2.0.0] - 2024-07-22

### Removed

- The formerly deprecated field `proj:espg` was removed in favor of `proj:code`.
A former `"proj:epsg": 3857` is now `"proj:code": "EPSG:3857"`.

## [v1.2.0] - 2024-07-22

### Added
Expand Down Expand Up @@ -42,7 +49,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

Initial independent release, see [previous history](https://github.com/radiantearth/stac-spec/commits/v1.0.0-rc.2/extensions/projection)

[Unreleased]: <https://github.com/stac-extensions/projection/compare/v1.2.0...HEAD>
[Unreleased]: <https://github.com/stac-extensions/projection/compare/v2.0.0...HEAD>
[v2.0.0]: <https://github.com/stac-extensions/projection/compare/v1.2.0...v2.0.0>
[v1.2.0]: <https://github.com/stac-extensions/projection/compare/v1.1.0...v1.2.0>
[v1.1.0]: <https://github.com/stac-extensions/projection/compare/v1.0.0...v1.1.0>
[v1.0.0]: <https://github.com/stac-extensions/projection/tree/v1.0.0>
34 changes: 8 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Projection Extension Specification

- **Title:** Projection
- **Identifier:** <https://stac-extensions.github.io/projection/v1.2.0/schema.json>
- **Identifier:** <https://stac-extensions.github.io/projection/v2.0.0/schema.json>
- **Field Name Prefix:** proj
- **Scope:** Item, Collection
- **Extension [Maturity Classification](https://github.com/radiantearth/stac-spec/tree/master/README.md#extension-maturity):** Stable
Expand Down Expand Up @@ -38,7 +38,6 @@ The fields in the table below can be used in these parts of STAC documents:
| Field Name | Type | Description |
| -------------- | ------------- | ----------- |
| proj:code | string\|null | Authority and specific code of the data source (e.g., ["EPSG:####"](https://epsg.org/), ["IAU:#####"](http://www.opengis.net/def/crs/IAU/2015)) |
| proj:epsg | integer\|null | **DEPRECATED.** [EPSG code](http://www.epsg-registry.org/) of the datasource |
| proj:wkt2 | string\|null | [WKT2](http://docs.opengeospatial.org/is/12-063r5/12-063r5.html) string representing the Coordinate Reference System (CRS) that the `proj:geometry` and `proj:bbox` fields represent |
| proj:projjson | [PROJJSON Object](https://proj.org/specifications/projjson.html)\|null | PROJJSON object representing the Coordinate Reference System (CRS) that the `proj:geometry` and `proj:bbox` fields represent |
| proj:geometry | [GeoJSON Geometry Object](https://tools.ietf.org/html/rfc7946#section-3.1) | Defines the footprint of this Item. |
Expand All @@ -57,28 +56,11 @@ would imply that the projection information also applies to the thumbnail if not
You may want to add the `proj:code` to the Item Properties though as this would provide an easy way to
filter for specific projection codes in an API. In this case you could override the `proj:code` for the thumbnail on the asset level.

### Additional Field Information

#### proj:epsg

This field has been deprecated in v1.2.0 in favor of `proj:code`.
`proj:epsg` will be removed in v2.0.0 of this extension.
> \[!WARNING]
> The field `proj:epsg` has been deprecated in v1.2.0 in favor of `proj:code` and has been removed in v2.0.0.
> For example, the former field `"proj:epsg": 32659` must be migrated to `"proj:code": "EPSG:32659"`.
For example, the following:

```json
{
"proj:epsg": 32659,
}
```

would be represented as:

```json
{
"proj:code": "EPSG:32659",
}
```
### Additional Field Information

#### proj:code

Expand All @@ -90,9 +72,9 @@ clients are likely to support are listed in the following table.
| Authority Name | URL |
| --------------------------------------- | ---------------------------------------------------------- |
| European Petroleum Survey Groups (EPSG) | <http://www.opengis.net/def/crs/EPSG> or <http://epsg.org> |
| International Astronomical Union (IAU) | <http://www.opengis.net/def/crs/IAU> |
| Open Geospatial Consortium (OGC) | <http://www.opengis.net/def/crs/OGC> |
| ESRI | <https://spatialreference.org/ref/esri/> |
| International Astronomical Union (IAU) | <http://www.opengis.net/def/crs/IAU> |
| Open Geospatial Consortium (OGC) | <http://www.opengis.net/def/crs/OGC> |
| ESRI | <https://spatialreference.org/ref/esri/> |

The `proj:code` field SHOULD be set to `null` in the following cases:

Expand Down
2 changes: 1 addition & 1 deletion examples/assets.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"stac_version": "1.0.0",
"stac_extensions": [
"https://stac-extensions.github.io/projection/v1.2.0/schema.json"
"https://stac-extensions.github.io/projection/v2.0.0/schema.json"
],
"type": "Feature",
"id": "20201211_223832_CS2_A",
Expand Down
2 changes: 1 addition & 1 deletion examples/collection.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"stac_version": "1.0.0",
"stac_extensions": [
"https://stac-extensions.github.io/projection/v1.2.0/schema.json",
"https://stac-extensions.github.io/projection/v2.0.0/schema.json",
"https://stac-extensions.github.io/item-assets/v1.0.0/schema.json"
],
"type": "Collection",
Expand Down
3 changes: 1 addition & 2 deletions examples/item.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"stac_version": "1.0.0",
"stac_extensions": [
"https://stac-extensions.github.io/projection/v1.2.0/schema.json"
"https://stac-extensions.github.io/projection/v2.0.0/schema.json"
],
"type": "Feature",
"id": "20201211_223832_CS2",
Expand Down Expand Up @@ -47,7 +47,6 @@
"cool_sensor_v1"
],
"gsd": 0.66,
"proj:epsg": 32659,
"proj:code": "EPSG:32659",
"proj:shape": [
5558,
Expand Down
2 changes: 1 addition & 1 deletion examples/item_custom_proj.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"stac_version": "1.0.0",
"stac_extensions": [
"https://stac-extensions.github.io/projection/v1.2.0/schema.json"
"https://stac-extensions.github.io/projection/v2.0.0/schema.json"
],
"type": "Feature",
"id": "20201211_223832_CS2",
Expand Down
12 changes: 2 additions & 10 deletions json-schema/schema.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://stac-extensions.github.io/projection/v1.2.0/schema.json",
"$id": "https://stac-extensions.github.io/projection/v2.0.0/schema.json",
"title": "Projection Extension",
"description": "STAC Projection Extension for STAC Items.",
"$comment": "This schema succeeds if the proj: fields are not used at all, please keep this in mind.",
Expand Down Expand Up @@ -77,22 +77,14 @@
"stac_extensions": {
"type": "array",
"contains": {
"const": "https://stac-extensions.github.io/projection/v1.2.0/schema.json"
"const": "https://stac-extensions.github.io/projection/v2.0.0/schema.json"
}
}
}
},
"fields": {
"type": "object",
"properties": {
"proj:epsg":{
"deprecated": true,
"title":"EPSG code",
"type":[
"integer",
"null"
]
},
"proj:code":{
"title":"Projection code",
"type":[
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"name": "stac-extensions",
"version": "1.2.0",
"version": "2.0.0",
"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/projection/v1.2.0/schema.json=./json-schema/schema.json",
"format-examples": "stac-node-validator . --format --schemaMap https://stac-extensions.github.io/projection/v1.2.0/schema.json=./json-schema/schema.json"
"check-examples": "stac-node-validator . --lint --verbose --schemaMap https://stac-extensions.github.io/projection/v2.0.0/schema.json=./json-schema/schema.json",
"format-examples": "stac-node-validator . --format --schemaMap https://stac-extensions.github.io/projection/v2.0.0/schema.json=./json-schema/schema.json"
},
"dependencies": {
"remark-cli": "^8.0.0",
Expand Down

0 comments on commit 730c0b6

Please sign in to comment.