Skip to content

Commit 395a17b

Browse files
authored
Merge pull request #1 from stac-api-extensions/pv/release-1.0.0-rc.2
update version for 1.0.0-rc.2 release
2 parents c0fe2fa + 0311645 commit 395a17b

File tree

6 files changed

+31
-206
lines changed

6 files changed

+31
-206
lines changed

.github/pull_request_template.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,4 @@
1010
**PR Checklist:**
1111

1212
- [ ] This PR has **no** breaking changes.
13-
- [ ] This PR does not make any changes to the core spec in the `stac-spec` directory (these are included as a subtree and should be updated directly in [radiantearth/stac-spec](https://github.com/radiantearth/stac-spec))
14-
- [ ] I have added my changes to the [CHANGELOG](https://github.com/radiantearth/stac-api-spec/blob/main/CHANGELOG.md) **or** a CHANGELOG entry is not required.
13+
- [ ] I have added my changes to the [CHANGELOG](https://github.com/stac-api-extensions/children/blob/main/CHANGELOG.md) **or** a CHANGELOG entry is not required.

CHANGELOG.md

Lines changed: 7 additions & 181 deletions
Original file line numberDiff line numberDiff line change
@@ -4,201 +4,27 @@ All notable changes to this project will be documented in this file.
44
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
55
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

7-
## [v1.0.0-rc.1] - 2022-03-17
7+
## [v1.0.0-rc.2] - TBD
88

9-
### Added
9+
None
1010

11-
- The CQL2 Accent and Case-insensitive Comparison
12-
(`http://www.opengis.net/spec/cql2/1.0/conf/accent-case-insensitive-comparison`) conformance class
13-
adds the ACCENTI and CASEI functions for case-insensitive comparison. These replace the UPPER and
14-
LOWER psuedo-functions that were previously part of the Advanced Comparison Operators class.
11+
## [v1.0.0-rc.1] - 2022-03-17
1512

1613
### Changed
1714

18-
- Query Extension is no longer deprecated.
1915
- Children conformance class now requires the /children endpoint includes all child catalogs or collections
2016
referenced via `child` link relations from the Landing Page
21-
- Clarified behavior of Transaction Extension endpoints:
22-
- PUT and PATCH of a body that changes the `collection` or `id` is disallowed.
23-
- POST, PUT, and PATCH do not need to include the `collection` attribute, as it should be derived from the URL.
24-
- POST and PUT can be used with a body that is at least a GeoJSON Feature, but does not have to be an Item, but for which
25-
the server can derive a valid Item, e.g., by populating the id and collection fields or adding links
26-
- Likewise, POST can be used with a body of a FeatureCollection that contains features that meet the same constraints.
2717
- Specifications now use the term "must" instead of "shall". The semantics of these words are identical.
28-
- Conformance class for Item Search Filter is now
29-
`https://api.stacspec.org/v1.0.0-beta.5/item-search#filter`, whereas before it was incorrectly stated as
30-
`https://api.stacspec.org/v1.0.0-beta.5/item-search#filter:item-search-filter`
31-
32-
### Deprecated
33-
34-
### Removed
35-
36-
### Fixed
3718

3819
## [v1.0.0-beta.5] - 2022-01-14
3920

4021
### Added
4122

42-
- Added `STAC API - Browseable` conformance class
4323
- Added `STAC API - Children` conformance class
44-
- Added description of how to support both search and browse in an API.
45-
- The paging mechanism via a Link with rel `next` or `prev` as defined for Item Search can also be used
46-
for the STAC API - Features endpoint `/collections/{collection_id}/items`, as described in OAFeat.
47-
- The paging mechanism via a Link with rel `next` or `prev` as defined for items can also be used
48-
for the STAC API - Features and STAC API - Collections endpoint `/collections`.
49-
50-
### Changed
51-
52-
- Limit parameter semantics now match OAFeat. Previously, the behavior was not precisely defined.
53-
- Filter Extension updates to align with changes to OAFeat CQL2 spec
54-
- Updated all "CQL" usages to "CQL2"
55-
- Most conformance class URIs are now prefixed with `http://www.opengis.net/spec/cql2/` instead
56-
of `http://www.opengis.net/spec/ogcapi-features-3/`
57-
- Conformance classes `http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/basic-cql`,
58-
`http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/cql-text`, and
59-
`http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/cql-json` have had `cql` replaced
60-
with `cql2` (in addition to the prefix change) to
61-
become `http://www.opengis.net/spec/cql2/1.0/conf/basic-cql2`,
62-
`http://www.opengis.net/spec/cql2/1.0/conf/cql2-text`, and
63-
`http://www.opengis.net/spec/cql2/1.0/conf/cql2-json`
64-
- Significant changes to CQL2 JSON format, now using `op` and `args` structure
65-
- Spatial operator `INTERSECTS` is now `S_INTERSECTS`
66-
- Temporal operator `ANYINTERACTS` is now `T_INTERSECTS`
67-
- Updated Example 3 (now Example 5) to make it clear that property to property comparisons require the
68-
Property-Property Comparisons conformance class
69-
- The CQL2 Case-insensitive Comparison
70-
(`http://www.opengis.net/spec/cql2/1.0/conf/case-insensitive-comparison`) conformance class
71-
that adds UPPER/LOWER terms or function CASEI for case-insensitive comparison has not been added
72-
to this spec yet, since the definition in CQL2 is in flux.
73-
- `service-desc` endpoint may return any service description format, typically a
74-
machine-consumable one (previous restricted required to be OpenAPI 3.0 JSON)
75-
- `service-doc` endpoint may return any service description format, typically a
76-
human-consumable one (previous restricted required to be HTML)
77-
78-
### Deprecated
79-
80-
### Removed
81-
82-
### Fixed
83-
84-
- Collection conformance class URI should be `https://api.stacspec.org/v1.0.0-beta.XXX/collections` instead
85-
of `http://stacspec.org/spec/api/1.0.0-beta.XXX/extensions/collections`
86-
- definition of Item object was missing `properties` as an attribute
87-
- Filter Extension - examples of using intervals and timestamps in CQL2 were incorrect and have been fixed
88-
- Filter Extension - examples are updated so that text and json examples are equivalent
89-
90-
## [v1.0.0-beta.4] - 2021-10-05
91-
92-
### Added
93-
94-
- Support binding Sort, Fields, and Context Extensions to STAC Features items resource
95-
endpoint (`/collections/{collectionId}/items`)
96-
- In Collections, added `canonical` rel type, added `/` and `/api` to list of endpoints
97-
- In Item Search, added endpoint table
98-
99-
### Changed
100-
101-
- Filter Extension - query language is now referred to as "CQL2" rather than CQL
102-
- Filter Extension now uses OAFeat Part 3 conformance class URIs
103-
- Filter Extension - The following changes have been made to the Filter Extension conformance classes to align with changes to the OAFeat CQL draft. All classes
104-
whose names have changed also have changed conformance URI strings.
105-
- "Basic CQL" now includes the "not equal" operator (`<>`)
106-
- "Basic CQL" has always supported datetime comparisons, but this is now explicitly mentioned
107-
- "Enhanced Comparison Operators" has been renamed "Advanced Comparison Operators". This is the same as the OAFeat CQL definition, except
108-
that it does not require the `upper` and `lower` functions.
109-
- "Enhanced Spatial Operators" has been renamed to just "Spatial Operators" (not to be confused with Basic Spatial Operators)
110-
- "Basic Temporal Operators" and "Enhanced Temporal Operators" have merged into "Temporal Operators"
111-
- "Functions" has been renamed "Custom Functions"
112-
- "Arithmetic" has been renamed "Arithmetic Expressions"
113-
- "Arrays" has been renamed "Array Operators"
114-
- "Queryable Second Operand" has been renamed "Property-Property Comparisons"
115-
- The required Link Relations and endpoints for each conformance class now use the wording of 'shall'
116-
instead of 'should'. While this technically changes the semantics, it was generally understood
117-
previously the semantics were those of 'shall' (must).
118-
- Explicitly state that the `/children` endpoint can return Catalog and Collection objects that have fewer
119-
fields than are available through other endpoints.
120-
121-
### Deprecated
122-
123-
### Removed
124-
125-
### Fixed
126-
127-
## [v1.0.0-beta.3] - 2021-08-06
128-
129-
### Added
130-
- Added STAC API - Collections definition (subset of STAC API - Features)
131-
- More thorough definitions for valid `datetime` and `bbox` query parameter values.
132-
133-
### Changed
134-
- Query extension not deprecated; recommendation to use Filter (https://github.com/radiantearth/stac-api-spec/pull/157)
135-
- Filter Extension conformance classes refactored to better align with STAC API use cases.
136-
- Renamed conformance class "Queryable First Operand"
137-
(https://api.stacspec.org/v1.0.0-beta.3/item-search#filter:queryable-first-operand) to
138-
"Queryable Second Operand"
139-
(https://api.stacspec.org/v1.0.0-beta.3/item-search#filter:queryable-second-operand)
140-
141-
### Deprecated
142-
143-
### Removed
144-
- Remove stac_version and stac_extensions fields in ItemCollection
145-
146-
### Fixed
147-
148-
## [v1.0.0-beta.2] - 2021-06-01
149-
150-
### Added
151-
- Added Filter extension to integrate OAFeat Part 3 CQL
152-
- Catalog and Collection definitions now have required field "type"
153-
- Added recommendation to enable CORS for public APIs
154-
155-
### Changed
156-
- Updated all STAC versions to 1.0.0
157-
- Passing the `ids` parameter to an item search does not deactivate other query parameters [#125](https://github.com/radiantearth/stac-api-spec/pull/125)
158-
- The first extent in a Collection is always the overall extent, followed by more specific extents. [opengeospatial/ogcapi-features#520](https://github.com/opengeospatial/ogcapi-features/pull/520)
159-
160-
### Deprecated
161-
- Query extension is now deprecated. Replaced by the Filter extension using OGC CQL.
162-
163-
### Removed
164-
165-
### Fixed
166-
- Updated text description of root ('/') endpoint (also called landing page) that the return type is a Catalog
167-
168-
## [v1.0.0-beta.1] - 2020-12-10
169-
170-
### Added
171-
- The landing page returns the conformance classes in a property `conformsTo`, which mirrors `GET /conformances` from OGC APIs.
172-
- Conformance classes for all the major functionality and extensions, to be referenced in a new `conformsTo` JSON object in the landing page.
173-
- Fragments: reusable OpenAPI documents for sort, filter, fields and context, along with explanation of how they work.
174-
- ItemCollection moved from [STAC Core](https://github.com/radiantearth/stac-spec/blob/v0.9.0/item-spec/itemcollection-spec.md) to this repo.
175-
176-
### Changed
177-
- Major re-organization of the content and directory structure to make better conformance classes.
178-
- STAC API Core is the landing page (a STAC catalog and conformance information).
179-
- Item Search is the `search` cross-collection item search resource.
180-
- STAC API - Features is the OGC API - Features standards to be used in a STAC API.
181-
- Extensions are specified in the relevant functionality directory, though they can share openapi yaml's in the 'fragments' directory.
182-
- Updated to STAC specification version 1.0.0-beta.2
183-
- Named explicit supported STAC core versions to be from 0.9.0 up to (and not including) 2.0.0
184-
- Context Extension OpenAPI spec was updated to remove the no longer used `next` attribute
185-
- Added root endpoint Link `search` must have `type` of `application/geo+json`
186-
- Corrected the description of endpoint `/collections` to say it returns an object per OAFeat, instead of an array of Collection
187-
- Updated transaction extension so it aligns with OGC API - Features Part 4: Simple Transactions
188-
189-
### Deprecated
190-
191-
### Removed
192-
193-
### Fixed
194-
- BBOX openapi yaml to only allow 4 or 6 element arrays
195-
- Fixed invalid OpenAPI files
19624

19725
## Older versions
19826

199-
See the [stac-spec CHANGELOG](https://github.com/radiantearth/stac-spec/blob/v0.9.0/CHANGELOG.md)
200-
for STAC API releases prior to or equal to version 0.9.0.
201-
202-
[Unreleased]: <https://github.com/radiantearth/stac-api-spec/compare/master...dev>
203-
[v1.0.0-beta.1]: <https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-beta.1>
204-
[v1.0.0-beta.2]: <https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-beta.2>
27+
[Unreleased]: <https://github.com/stac-api-extensions/children/compare/v1.0.0-rc.2..main>
28+
[v1.0.0-rc.2]: <https://github.com/stac-api-extensions/children/tree/v1.0.0-rc.2>
29+
[v1.0.0-rc.1]: <https://github.com/stac-api-extensions/children/tree/v1.0.0-rc.1>
30+
[v1.0.0-beta.5]: <https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-beta.2>

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# STAC API - Children Extension
22

3-
- **OpenAPI specification:** [openapi.yaml](openapi.yaml) ([rendered version](https://api.stacspec.org/v1.0.0-rc.1/children))
3+
- **OpenAPI specification:** [openapi.yaml](openapi.yaml) ([rendered version](https://api.stacspec.org/v1.0.0-rc.2/children))
44
- **Conformance Classes:**
5-
- <https://api.stacspec.org/v1.0.0-rc.1/children>
6-
- **[Maturity Classification](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.1/README.md#maturity-classification):** Proposal
5+
- <https://api.stacspec.org/v1.0.0-rc.2/children>
6+
- **[Maturity Classification](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.2/README.md#maturity-classification):** Proposal
77
- **Dependencies**:
8-
- [STAC API - Core](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.1/core)
8+
- [STAC API - Core](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.2/core)
99

1010
- [STAC API - Children Extension](#stac-api---children-extension)
1111
- [Link Relations](#link-relations)
@@ -28,7 +28,7 @@ but the objects must still be valid Catalogs and Collections.
2828
## Link Relations
2929

3030
This conformance class also requires implementation of the link relations in the
31-
[STAC API - Core](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.1/core) conformance class.
31+
[STAC API - Core](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.2/core) conformance class.
3232

3333
The following Link relations must exist in the Landing Page (root).
3434

@@ -46,7 +46,7 @@ The following Link relations must exist in the `/children` endpoint response.
4646
## Endpoints
4747

4848
This conformance class also requires for the endpoints in the
49-
[STAC API - Core](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.1/core) conformance class to be implemented.
49+
[STAC API - Core](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.2/core) conformance class to be implemented.
5050

5151
| Endpoint | Returns | Description |
5252
| ----------- | ------- | ---------------------------------------------------- |
@@ -60,7 +60,7 @@ array of Links in a field `links`.
6060

6161
The `/children` endpoint supports a pagination mechanism that aligns with pagination as described in the
6262
OGC API - Common - Part 2: Geospatial Data specification. This is described in detail in
63-
the [STAC - Features Collection Pagination section](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.1/ogcapi-features/README.md#collection-pagination).
63+
the [STAC - Features Collection Pagination section](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.2/ogcapi-features/README.md#collection-pagination).
6464
To the greatest extent possible, the catalog should be structured such that all children can be
6565
retrieved from the endpoint in a single call.
6666

@@ -82,9 +82,9 @@ The STAC API Landing Page should look like the following (note the `child` link
8282
"description": "This Catalog aims to demonstrate the a simple landing page",
8383
"type": "Catalog",
8484
"conformsTo": [
85-
"https://api.stacspec.org/v1.0.0-rc.1/core",
86-
"https://api.stacspec.org/v1.0.0-rc.1/children",
87-
"https://api.stacspec.org/v1.0.0-rc.1/browseable"
85+
"https://api.stacspec.org/v1.0.0-rc.2/core",
86+
"https://api.stacspec.org/v1.0.0-rc.2/children",
87+
"https://api.stacspec.org/v1.0.0-rc.2/browseable"
8888
],
8989
"links": [
9090
{

openapi.yaml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
openapi: 3.0.3
22
info:
33
title: STAC API - Children
4-
version: '1.0.0-rc.1'
4+
version: '1.0.0-rc.2'
55
description: >-
66
This is an OpenAPI definition of the SpatioTemporal Asset Catalog API - Children
77
specification.
@@ -36,16 +36,16 @@ paths:
3636
content:
3737
application/json:
3838
schema:
39-
$ref: 'https://api.stacspec.org/v1.0.0-rc.1/core/openapi.yaml#/components/schemas/landingPage'
39+
$ref: 'https://api.stacspec.org/v1.0.0-rc.2/core/openapi.yaml#/components/schemas/landingPage'
4040
example:
4141
stac_version: '1.0.0'
4242
type: Catalog
4343
id: sentinel
4444
title: Copernicus Sentinel Imagery
4545
description: Catalog of Copernicus Sentinel 1 and 2 imagery.
4646
conformsTo:
47-
- 'https://api.stacspec.org/v1.0.0-rc.1/core'
48-
- 'https://api.stacspec.org/v1.0.0-rc.1/children'
47+
- 'https://api.stacspec.org/v1.0.0-rc.2/core'
48+
- 'https://api.stacspec.org/v1.0.0-rc.2/children'
4949
- 'http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/core'
5050
- 'http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/oas30'
5151
- 'http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/geojson'
@@ -92,13 +92,13 @@ components:
9292
- children
9393
properties:
9494
links:
95-
$ref: 'https://api.stacspec.org/v1.0.0-rc.1/ogcapi-features/openapi.yaml#/components/schemas/links'
95+
$ref: 'https://api.stacspec.org/v1.0.0-rc.2/ogcapi-features/openapi.yaml#/components/schemas/links'
9696
children:
9797
type: array
9898
items:
9999
anyOf:
100-
- $ref: 'https://api.stacspec.org/v1.0.0-rc.1/ogcapi-features/openapi.yaml#/components/schemas/catalog'
101-
- $ref: 'https://api.stacspec.org/v1.0.0-rc.1/ogcapi-features/openapi.yaml#/components/schemas/collection'
100+
- $ref: 'https://api.stacspec.org/v1.0.0-rc.2/ogcapi-features/openapi.yaml#/components/schemas/catalog'
101+
- $ref: 'https://api.stacspec.org/v1.0.0-rc.2/ogcapi-features/openapi.yaml#/components/schemas/collection'
102102
responses:
103103
Children:
104104
description: |-
@@ -113,4 +113,4 @@ components:
113113
content:
114114
application/json:
115115
schema:
116-
$ref: 'https://api.stacspec.org/v1.0.0-rc.1/ogcapi-features/openapi.yaml#/components/schemas/exception'
116+
$ref: 'https://api.stacspec.org/v1.0.0-rc.2/ogcapi-features/openapi.yaml#/components/schemas/exception'

package-lock.json

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "api-spec",
3-
"version": "1.0.0-rc.1",
3+
"version": "1.0.0-rc.2",
44
"description": "STAC API helpers to generate, serve and check the API spec.",
55
"repository": "https://github.com/radiantearth/stac-api-spec",
66
"license": "Apache-2.0",
@@ -91,4 +91,4 @@
9191
]
9292
]
9393
}
94-
}
94+
}

0 commit comments

Comments
 (0)