Skip to content

Commit ce7f726

Browse files
author
Phil Varner
authored
Merge pull request #319 from Kristianwhittick/patch-1
Minor grammar corrections to overview.md
2 parents e365f71 + 54e3619 commit ce7f726

2 files changed

Lines changed: 22 additions & 61 deletions

File tree

overview.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ usually want to access
66
a subset of the entire catalog, such as for a certain date range, in a particular area of interest, or matching properties
77
they care about. STAC API extensions specify those query parameters, and compliant servers return STAC [Item](stac-spec/item-spec/README.md)
88
objects that
9-
match the user's preferences. A lot of additional functionality can added through the [OGC API](https://ogcapi.ogc.org/) family of
9+
match the user's preferences. A lot of additional functionality can be added through the [OGC API](https://ogcapi.ogc.org/) family of
1010
standards, particularly [OGC API - Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) (OAFeat, for our
1111
shorthand). Notes on implementation recommendations may be found [here](implementation.md).
1212

@@ -15,16 +15,16 @@ shorthand). Notes on implementation recommendations may be found [here](impleme
1515
### Core
1616

1717
The [core](core/) of STAC API simply returns a valid [STAC Catalog](stac-spec/catalog-spec/catalog-spec.md) and a description
18-
of what parts of the fuller STAC API specification it conforms to. The `links` section of the Catalog is the jumping
19-
off point for the more powerful capabilities - it contains a list of URL's, each described by particular link
18+
of what parts of the fuller STAC API specification it conforms to. The `links` section of the Catalog is the jumping-off
19+
point for the more powerful capabilities - it contains a list of URLs, each are described by particular link
2020
'relationships' (`rel`) to indicate their functionality. Note that the [STAC Core specification](stac-spec) provides
21-
most all the content of API responses - the STAC API is primarily concerned with the return of STAC
21+
most of the content of API responses - the STAC API is primarily concerned with the return of STAC
2222
[Item](stac-spec/item-spec/README.md) and [Collection](stac-spec/collection-spec/README.md) objects via a
2323
web API. See the [rendered OpenAPI document](https://api.stacspec.org/v1.0.0-rc.1/core) for more details.
2424

2525
There are then two major sets of functionality that build on the core, which are designed to be complementary, letting
26-
implementations choose which parts they want to utilize. Most every STAC API implements at least one, and many follow
27-
two or all three.
26+
implementations choose which parts they want to utilize. Almost every STAC API implements at least one and many follow
27+
two or all three.
2828

2929
### Item Search
3030

@@ -38,7 +38,7 @@ document](https://api.stacspec.org/v1.0.0-rc.1/item-spec) for more details.
3838
### Collections
3939

4040
The other most common set of functionality is [Collections](collections/). This is implemented with the `/collections`
41-
endpoint and linked to with the `data` relation. The response is a complete list of available STAC `Collection`
41+
endpoint and linked with the `data` relation. The response is a complete list of available STAC `Collection`
4242
entities. Each individual collection resource can be accessed with the endpoints like `/collection/{collectionId}`
4343
by collection ID. This is a subset of the functionality defined by the *STAC API - Features* conformance class.
4444

@@ -71,9 +71,9 @@ for more details.
7171
### Extensions & Fragments
7272

7373
Both STAC API and OAFeat allow 'extensions' that can be added for additional functionality. The STAC community has
74-
created a number of extensions to OAFeat, in order to meet requirements of its implementors, and the complete list
75-
can be found in the [extensions document](extensions.md), which links to each of them and details their maturity .
76-
These are specified in OpenAPI, which works cleanly when the new functionality is a new api location (a complete
74+
created a number of extensions to OAFeat, in order to meet the requirements of its implementors and the complete list
75+
can be found in the [extensions document](extensions.md), which links to each of them and details their maturity.
76+
These are specified in OpenAPI, which works cleanly when the new functionality is a new API location (a complete
7777
resource, or adding POST to an existing one). Many of the additions, however, are done at the parameter or response
7878
level, like adding a `sortby` field to return ordered results. To make these reusable by both Item Search and OAFeat,
7979
in STAC they are specified in the [fragments/](fragments/) directory, where the core functionality is described.
@@ -82,7 +82,7 @@ class (to say, for example, that item-search supports `sortby` but ogcapi-featur
8282
on a fragment then it will likely just be a thin wrapper to declare the conformance. This is a bit less than ideal,
8383
but it seemed to be the best approach that actually works with OpenAPI.
8484

85-
We are working to fully align STAC's OAFeat extensions to be the same as the OGC API building blocks being worked on,
85+
We are working to fully align STAC's OAFeat extensions to be the same as the OGC API building blocks being worked on
8686
so that every STAC extension is specified at the OGC API level. The end goal is for STAC API to just present a
8787
curated set of extension options.
8888

@@ -92,10 +92,10 @@ This version of STAC API depends on OGC API - Features - Part 1: Core [Version 1
9292
Future versions will likely depend on [OGC API Common](https://github.com/opengeospatial/ogcapi-common) and additional parts of
9393
Features as components evolve and mature.
9494

95-
This version of STAC API is intended to work with any STAC core specification version 0.9.x or 1.x.x (included betas), but is not
95+
This version of STAC API is intended to work with any STAC core specification version 0.9.x or 1.x.x (including betas), but is not
9696
designed to work with STAC 2.0 and above (since we use [SemVer](https://semver.org/) it may introduce backwards incompatible changes).
9797
The STAC API spec is released with the latest stable STAC core specification version included in the [`/stac-spec`](stac-spec/)
98-
directory as a [submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules). To determine which version it is just check the
98+
directory as a [submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules). To determine which version it is, just check the
9999
[`/stac-spec/CHANGELOG.md`](stac-spec/CHANGELOG.md) for the topmost version & release date.
100100

101101
## Capabilities List
@@ -123,15 +123,15 @@ STAC API is evolving to utilize OAFeat's
123123
'[Conformance](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html#_declaration_of_conformance_classes)'
124124
JSON structure. For
125125
STAC API 1.0.0-rc.1 we declare new STAC Conformance classes, with the core ones detailed in the table below. [STAC
126-
Features](ogcapi-features) requires the core OAFeat conformance classes, and declares that those endpoints return
126+
Features](ogcapi-features) requires the core OAFeat conformance classes and declares that those endpoints return
127127
STAC Collection and Feature objects.
128128
The core STAC conformance classes communicate the conformance JSON only in the root (`/`) document, while OGC API
129129
requires they also live at the `/conformance` endpoint. STAC's conformance structure is detailed in the
130130
[core](core/). Note all
131131
conformance URIs serve up a rendered HTML version of the corresponding OpenAPI document at the given location.
132132

133133
**NOTE:** *By 1.0.0 we aim to have requirements classes specified in detail, as testable assertions,
134-
like OGC does, but for now the core reference is just this spec document and the OpenAPI yaml. We also desire to
134+
as OGC does, but for now the core reference is just this spec document and the OpenAPI YAML. We also desire to
135135
have the URIs for conformance to actually resolve to machine-readable information clients can use.*
136136

137137
### Conformance Class Table

package-lock.json

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

0 commit comments

Comments
 (0)