You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+41-4
Original file line number
Diff line number
Diff line change
@@ -14,6 +14,41 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
14
14
15
15
### Fixed
16
16
17
+
## [v1.0.0-rc.1] - 2021-03-03
18
+
19
+
### Added
20
+
21
+
- Catalog and Collection now require a `type` parameter, to be set to `Catalog` or `Collection` for clients to more easily distinguish them easily. ([#971](https://github.com/radiantearth/stac-spec/pull/971))
22
+
- Collection specification adds Assets (previously needed Collections Asset extension to do that). ([#1008](https://github.com/radiantearth/stac-spec/pull/1008))
23
+
- 'via' and 'canonical' rel types are now options in Items. ([#884](https://github.com/radiantearth/stac-spec/pull/884))
24
+
- In Extensions list there is now reference to three new (non-core) extensions: [processing](https://github.com/stac-extensions/processing), [file info](https://github.com/stac-extensions/file) and [card4l](https://github.com/stac-extensions/card4l). These would have been added to the stac-spec repo, except all non-core extensions were moved to [stac-extensions](https://github.com/stac-extensions/) org. ([#1024](https://github.com/radiantearth/stac-spec/pull/1024))
25
+
- 'summaries' are now available in the Catalog spec, so both catalogs and collections can make use of it. ([#903](https://github.com/radiantearth/stac-spec/issues/903))
26
+
- There is a new recommendation to enable CORS. ([#940](https://github.com/radiantearth/stac-spec/pull/940))
27
+
- A Best Practice section on 'requester pays' cloud buckets was added. ([#1021](https://github.com/radiantearth/stac-spec/pull/1021))
28
+
- A new Best Practice section explains Asset Roles, plus some lists of potential roles for people to use (in best practices, sar and eo). ([#989](https://github.com/radiantearth/stac-spec/pull/989))
29
+
- There is a new Best Practice recommendation to keep collections at consistent levels. ([#1009](https://github.com/radiantearth/stac-spec/pull/1009))
30
+
31
+
### Changed
32
+
33
+
- The [Stats Object](collection-spec/collection-spec.md#stats-object) for Collection `summaries` changed `min` to `minimum` and `max` to `maximum` to align with JSON Schema. ([#967](https://github.com/radiantearth/stac-spec/pull/967))
34
+
- URIs (usually found int properties like `href`, `url`) are now validated using the `iri-reference` format in JSON Schema (allows international characters in URIs) ([#953](https://github.com/radiantearth/stac-spec/pull/953))
35
+
- Enhanced the way the spec talks about ID's to encourage more global uniqueness. ([#883](https://github.com/radiantearth/stac-spec/pull/883))
36
+
- Clarified how collection-level asset object properties do not remove the need for item-level asset object properties in the `item-assets` extension ([#880](https://github.com/radiantearth/stac-spec/pull/880))
37
+
- Made `summaries` to be *strongly recommended* - everyone should strive to implement them, as they are very useful. ([#985](https://github.com/radiantearth/stac-spec/pull/985))
38
+
- Moved examples from individual directories into a single /examples folder at the root, and evolved them to be more representative. ([#955](https://github.com/radiantearth/stac-spec/pull/955))
39
+
- Renamed "Scientific Extension" to "Scientific Citation Extension" ([#990](https://github.com/radiantearth/stac-spec/issues/990))
40
+
- Relaxed the regular expression for DOIs in the scientific extension ([#910](https://github.com/radiantearth/stac-spec/issues/910))
41
+
-`proj:geometry` allows all GeoJSON geometries instead of just a polygon. ([#995](https://github.com/radiantearth/stac-spec/pull/995))
42
+
43
+
### Removed
44
+
45
+
- Checksum extension (field `checksum:multihash`). Use File Info extension (field `file:checksum`) instead for assets. There's no replacement for links. ([#934](https://github.com/radiantearth/stac-spec/pull/934))
46
+
- Collection Assets extension, as the core construct of Assets in a Collection is now part of the core Collection spec. No change is required except removing `collection-assets` from the list of `stac_extensions`. ([#1008](https://github.com/radiantearth/stac-spec/pull/1008))
47
+
- Numerous extensions (Data Cube, Item Assets, Point Cloud, SAR, Single File STAC, Tiled Assets, Timestamps & Versioning) have been moved out of the core specification, into their own repos in the [stac-extensions](https://github.com/stac-extensions/) GitHub organization. They must now be referred to by their schemas directly - the name shortcuts for them are no longer valid. ([#1024](https://github.com/radiantearth/stac-spec/pull/1024))
48
+
49
+
### Fixed
50
+
51
+
- Fixed JSON Schema for `providers` (Collections and Items) to be an object and require a `name`. ([#924](https://github.com/radiantearth/stac-spec/pull/924))
17
52
18
53
## [v1.0.0-beta.2] - 2020-07-08
19
54
@@ -23,6 +58,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
23
58
### Changed
24
59
- Clarification on null geometries, making bbox not required if a null geometry is used.
25
60
- Multiple extents (bounding boxes / intervals) are allowed per Collection
61
+
- In the scientific extension, a link with the rel-type 'cite-as' SHOULD be used for the main publication of the dataset (the same as the one described in `sci:doi`), and not for the DOIs referenced in the `sci:publications` property.
26
62
27
63
### Removed
28
64
- Validation instructions
@@ -82,7 +118,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
82
118
- New [View Geometry Extension](extensions/view/README.md)
83
119
- STAC API:
84
120
- Added the [Item and Collection API Version extension](https://github.com/radiantearth/stac-api-spec/tree/master/extensions/version/README.md) to support versioning in the API specification
85
-
- Run `npmrunserve`or `npmrunserve-ext` to quickly render development versions of the OpenAPI spec in the browser
121
+
- Run `npmrunserve`or `npmrunserve-ext` to quickly render development versions of the OpenAPI spec in the browser
86
122
-[Basics](item-spec/common-metadata.md#basics) added to Common Metadata definitions with new `description` field for
87
123
Item properties
88
124
- New fields to the `link` object to facilitate [pagination support for POST requests](https://github.com/radiantearth/stac-api-spec/tree/master/api-spec.md#paging-extension)
@@ -92,7 +128,7 @@ Item properties
92
128
### Changed
93
129
- Support for [CommonMark 0.29 instead of CommonMark 0.28](https://spec.commonmark.org/0.29/changes.html)
94
130
- Collection field `property` and the merge ability moved to a new extension 'Commons'
95
-
- Added attribute`roles` to Item assets (also Asset definitions extension), to be used similarly to Link `rel`
131
+
- Added field`roles` to Item assets (also Asset definitions extension), to be used similarly to Link `rel`
96
132
- Updated API yaml to clarify bbox filter should be implemented without brackets. Example: `bbox=160.6,-55.95,-170,-25.89`
97
133
- Collection `summaries` merge array fields now
98
134
- Several fields have been moved from extensions or item fields to the [Common Metadata fields](item-spec/common-metadata.md):
@@ -119,10 +155,10 @@ Item properties
119
155
-`search` extension renamed to `context` extension. JSON object renamed from `search:metadata` to `context`
120
156
- Removed "next" from the search metadata and query parameter, added POST body and headers to the links for paging support
121
157
- Query Extension - type restrictions on query predicates are more accurate, which may require additional implementation support
122
-
- Item `title` definition moved from core Item fields to [Common Metadata Basics](item-spec/common-metadata.md#basics)
158
+
- Item `title` definition moved from core Item fields to [Common Metadata Basics](item-spec/common-metadata.md#basics)
123
159
fields. No change is required for STAC Items.
124
160
-`putFeature` can return a `PreconditionFailed` to provide more explicit information when the resource has changed in the server
125
-
-[Sort extension](https://github.com/radiantearth/stac-api-spec/tree/master/extensions/sort) now uses "+" and "-" prefixes for GET requests to denote sort order.
161
+
-[Sort extension](https://github.com/radiantearth/stac-api-spec/tree/master/extensions/sort) now uses "+" and "-" prefixes for GET requests to denote sort order.
126
162
- Clarified how `/search` links must be added to `/` and changed that links to both GET and POST must be provided now that the method can be specified in links
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+25-6
Original file line number
Diff line number
Diff line change
@@ -33,18 +33,18 @@ you to change the base in GitHub's PR creation page.
33
33
select breaking changes, but after 1.0 this will change)
34
34
35
35
All pull requests should submit clean markdown, which is checked by the continuous integration
36
-
system. Please use `check-markdown` locally, as described in the [next section](#using-check-markdown-locally),
36
+
system. Please use `npm run check` locally, as described in the [next section](#check-files),
37
37
to ensure that the checks on the pull request succeed. If it does not then you can look at the
38
-
mistakes online, which are the same as running `check-markdown` locally would surface.
38
+
mistakes online, which are the same as running `npm run check` locally would surface.
39
39
40
40
All pull requests that modify or create JSON schema files or examples should use [JSON formatter](https://jsonformatter.org/) to keep files consistent across the repo.
41
41
42
42
All pull requests additionally require a review of two STAC core team members. Releases are cut
43
43
from dev to master (and require 3 approvals), see the [process](process.md) document for more details.
44
44
45
-
### Using check-markdown locally
45
+
### Check files
46
46
47
-
The same check-markdown program that runs as a check on PR's is part of the repo and can be run locally.
47
+
The same check-markdown and check-examples programs that runs as a check on PR's is part of the repo and can be run locally.
48
48
To install you'll need npm, which is a standard part of any [node.js installation](https://nodejs.org/en/download/). Alternatively, you can also use [yarn](https://yarnpkg.com/) instead of npm. In this case replace all occurrences of `npm` with `yarn` below.
49
49
50
50
First you'll need to install everything with npm once. Just navigate to the root of the stac-spec repo and on
@@ -53,10 +53,29 @@ your command line run:
53
53
```bash
54
54
npm install
55
55
```
56
-
Then to do the check on your markdown you run:
56
+
57
+
Then to do the check for markdown and examples you run:
58
+
59
+
```bash
60
+
npm run check
61
+
```
62
+
63
+
This will spit out the same texts that you see online, and you can then go and fix your markdown or examples.
64
+
65
+
To just check the markdown run:
57
66
58
67
```bash
59
68
npm run check-markdown
60
69
```
61
70
62
-
This will spit out the same text that you see online, and you can then go and fix your markdown.
71
+
To just check the examples run:
72
+
73
+
```bash
74
+
npm run check-examples
75
+
```
76
+
77
+
To automatically format / pretty-print the examples run:
0 commit comments