Skip to content

Commit 1615434

Browse files
authored
Merge pull request #153 from radiantearth/dev
dev -> master merge for 1.0.0-beta.2
2 parents 77c77c6 + 4527f64 commit 1615434

File tree

89 files changed

+8840
-286
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

89 files changed

+8840
-286
lines changed

.circleci/config.yml

+16-3
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,6 @@ jobs:
2727
- image: circleci/node:12
2828
steps:
2929
- checkout
30-
- run:
31-
name: init_submodules
32-
command: git submodule update --init --recursive
3330
- save_cache:
3431
key: v0-repo-{{ .Branch }}-{{ .Revision }}
3532
paths:
@@ -72,6 +69,16 @@ jobs:
7269
command: |
7370
ssh-keyscan github.com >> ~/.ssh/known_hosts
7471
npm run publish-openapi -- $CIRCLE_TAG
72+
check-core-changes:
73+
working_directory: ~/stac
74+
docker:
75+
- image: circleci/node:12
76+
steps:
77+
- *restore_repo
78+
- *restore_dependencies
79+
- run:
80+
name: check-core-changes
81+
command: npm run check-stac-spec-changes --compare-to=<< pipeline.git.base_revision >>
7582

7683
workflows:
7784
version: 2
@@ -87,6 +94,12 @@ workflows:
8794
filters:
8895
tags:
8996
only: /^v.*/
97+
- check-core-changes:
98+
requires:
99+
- validate
100+
filters:
101+
tags:
102+
only: /^v.*/
90103
- publish:
91104
requires:
92105
- build

.circleci/rc.yaml

+4-7
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,13 @@ plugins:
44
# Apply some recommended defaults for consistency
55
- remark-preset-lint-consistent
66
- remark-preset-lint-recommended
7-
# No HTML for security - can't activate yet due to STAC logo in README.md
8-
# - lint-no-html
7+
# - lint-no-html
98
# General formatting
109
- - remark-lint-emphasis-marker
1110
- '*'
1211
- remark-lint-hard-break-spaces
1312
- remark-lint-blockquote-indentation
1413
- remark-lint-no-consecutive-blank-lines
15-
# Detect overly long lines - be liberal for now and don't restrict to 80 yet
1614
- - remark-lint-maximum-line-length
1715
- 150
1816
# Code
@@ -23,13 +21,14 @@ plugins:
2321
- 'fenced'
2422
# Headings
2523
- remark-lint-heading-increment
26-
- remark-lint-no-duplicate-headings
2724
- remark-lint-no-multiple-toplevel-headings
2825
- remark-lint-no-heading-punctuation
2926
- - remark-lint-maximum-heading-length
3027
- 70
3128
- - remark-lint-heading-style
3229
- atx
30+
- - remark-lint-no-shortcut-reference-link
31+
- false
3332
# Lists
3433
- remark-lint-list-item-bullet-indent
3534
- remark-lint-ordered-list-marker-style
@@ -41,6 +40,4 @@ plugins:
4140
- space
4241
# Tables
4342
- remark-lint-table-pipes
44-
# - remark-lint-table-pipe-alignment # Wait for https://github.com/remarkjs/remark-lint/issues/226
45-
# Urls
46-
- remark-lint-no-literal-urls
43+
- remark-lint-no-literal-urls

.github/pull_request_template.md

+1
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,5 @@
1010

1111
- [ ] This PR is made against the dev branch (all proposed changes except releases should be against dev, not master).
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))
1314
- [ ] I have added my changes to the [CHANGELOG](https://github.com/radiantearth/stac-api-spec/blob/dev/CHANGELOG.md) **or** a CHANGELOG entry is not required.

.gitmodules

-3
This file was deleted.

.remarkignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/CHANGELOG.md

CHANGELOG.md

+33-2
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,39 @@ 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-
## [Unreleased][]
7+
## [Unreleased]
88

9-
## [v1.0.0-beta.1][] - 2020-12-10
9+
### Added
10+
11+
### Changed
12+
13+
### Deprecated
14+
15+
### Removed
16+
17+
### Fixed
18+
19+
## [v1.0.0-beta.2] - 2020-06-01
20+
21+
### Added
22+
- Added Filter extension to integrate OAFeat Part 3 CQL
23+
- Catalog and Collection definitions now have required field "type"
24+
- Added recommendation to enable CORS for public APIs
25+
26+
### Changed
27+
- Updated all STAC versions to 1.0.0
28+
- Passing the `ids` parameter to an item search does not deactivate other query parameters [#125](https://github.com/radiantearth/stac-api-spec/pull/125)
29+
- 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)
30+
31+
### Deprecated
32+
- Query extension is now deprecated. Replaced by the Filter extension using OGC CQL.
33+
34+
### Removed
35+
36+
### Fixed
37+
- Updated text description of root ('/') endpoint (also called landing page) that the return type is a Catalog
38+
39+
## [v1.0.0-beta.1] - 2020-12-10
1040

1141
### Added
1242
- The landing page returns the conformance classes in a property `conformsTo`, which mirrors `GET /conformances` from OGC APIs.
@@ -42,3 +72,4 @@ for STAC API releases prior to or equal to version 0.9.0.
4272

4373
[Unreleased]: <https://github.com/radiantearth/stac-api-spec/compare/master...dev>
4474
[v1.0.0-beta.1]: <https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-beta.1>
75+
[v1.0.0-beta.2]: <https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-beta.2>

CODE_OF_CONDUCT.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ members of the project's leadership.
7070
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
7171
available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
7272

73-
[homepage]: <https://www.contributor-covenant.org>
74-
7573
For answers to common questions about this code of conduct, see
7674
<https://www.contributor-covenant.org/faq>
75+
76+
[homepage]: <https://www.contributor-covenant.org>

README.md

+21-10
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,15 @@
1+
<!--lint disable no-html-->
12
<img src="https://github.com/radiantearth/stac-site/raw/master/images/logo/stac-030-long.png" alt="stac-logo" width="700"/>
23

34
# STAC API
45

6+
- [STAC API](#stac-api)
7+
- [About](#about)
8+
- [Stability Note](#stability-note)
9+
- [Communication](#communication)
10+
- [In this repository](#in-this-repository)
11+
- [Contributing](#contributing)
12+
513
## About
614

715
The SpatioTemporal Asset Catalog (STAC) specification aims to standardize the way geospatial assets are exposed online and queried.
@@ -11,26 +19,26 @@ time. The core STAC specification lives at [gitub.com/radiantearth/stac-spec](ht
1119
A STAC API is the dynamic version of a SpatioTemporal Asset Catalog. It returns a STAC [Catalog](stac-spec/catalog-spec/catalog-spec.md),
1220
[Collection](stac-spec/collection-spec/collection-spec.md), [Item](stac-spec/item-spec/item-spec.md),
1321
or a STAC API [ItemCollection](fragments/itemcollection/README.md), depending on the endpoint.
14-
Catalogs and Collections are JSON, while Items and ItemCollections are GeoJSON-compliant entities with foreign members.
15-
Typically, a Feature is used when returning a single Item, and FeatureCollection when multiple Items (rather than a JSON array of Item entities).
22+
Catalog and Collection objects are JSON, while Item and ItemCollection objects are GeoJSON-compliant entities with foreign members.
23+
Typically, a Feature is used when returning a single Item object, and FeatureCollection when multiple Item objects (rather than a
24+
JSON array of Item entities).
1625

1726
The API can be implemented in compliance with the *[OGC API - Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html)* standard
1827
(we'll use OAFeat for shorthand). In this case STAC API can be thought of as a specialized Features API
19-
to search STAC Catalogs, where the features returned are STAC [Items](stac-spec/item-spec/item-spec.md),
28+
to search STAC catalogs, where the features returned are STAC [Item](stac-spec/item-spec/item-spec.md) objects,
2029
that have common properties, links to their assets and geometries that represent the footprints of the geospatial assets.
2130

2231
The specification for STAC API is provided as files that follow the [OpenAPI](http://openapis.org/) 3.0 specification,
23-
rendered online into HTML at <https://api.stacspec.org/v1.0.0-beta.1>, in addition to human-readable documentation.
32+
rendered online into HTML at <https://api.stacspec.org/v1.0.0-beta.2>, in addition to human-readable documentation.
2433

2534
## Stability Note
2635

2736
This specification has evolved over the past couple years, and is used in production in a variety of deployments. It is
2837
currently in a 'beta' state, with no major changes anticipated. For 1.0-beta we remain fully aligned with [OGC API -
2938
Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) Version 1.0, and we are working to stay aligned
30-
as the additional OGC API components mature. This may result in minor changes as things evolve. The STAC API specification
31-
32-
follows [Semantic Versioning](https://semver.org/), so once 1.0.0 is reached any breaking change will require the spec to
33-
go to 2.0.0.
39+
as the additional OGC API components mature. This may result in minor changes as things evolve. The STAC API
40+
specification follows [Semantic Versioning](https://semver.org/), so once 1.0.0 is reached any breaking change
41+
will require the spec to go to 2.0.0.
3442

3543
## Communication
3644

@@ -45,11 +53,11 @@ The **[Overview](overview.md)** document describes all the various parts of the
4553

4654
**STAC API - Core Specification:**
4755
The *[core](core/)* folder describes the core STAC API specification that enables browsing catalogs and
48-
retrieving the API capabilities. This includes the OpenAPI schemas for STAC items, catalogs and collections.
56+
retrieving the API capabilities. This includes the OpenAPI schemas for STAC Item, Catalog and Collection objects.
4957

5058
**STAC API - Item Search Specification:**
5159
The *[item-search](item-search)* folder contains the Item Search specification, which enables
52-
cross-collection search of STAC Items at a `search` endpoint, as well as a number of extensions.
60+
cross-collection search of STAC Item objects at a `search` endpoint, as well as a number of extensions.
5361

5462
**STAC API - Features:**
5563
The *[ogcapi-features](ogcapi-features)* folder describes how a STAC API can fully implement [OGC API -
@@ -73,6 +81,9 @@ Sub-modules aren't checked out by default, so to get the directory populated
7381
either use `git submodule update --init --recursive` if you've already cloned it,
7482
or clone from the start with `git clone --recursive [email protected]:radiantearth/stac-api-spec.git`.
7583

84+
**Implementation Recommendations:** Recommendations for implementing a STAC API may be found [here](implementation.md).
85+
These are mostly concerns that apply to an entire API implementation and are not part of the specification itself.
86+
7687
## Contributing
7788

7889
Anyone building software that catalogs imagery or other geospatial assets is welcome to collaborate.

build/swagger-config.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
openapi: 3.0.3
22
info:
33
title: STAC API - Complete
4-
version: 1.0.0-beta.1
4+
version: 1.0.0-beta.2
55
apis:
66
- url: 'build/core/openapi.yaml'
77
paths:

0 commit comments

Comments
 (0)