diff --git a/browseable/README.md b/browseable/README.md index 2dfe477a..1bf83faf 100644 --- a/browseable/README.md +++ b/browseable/README.md @@ -70,32 +70,32 @@ eventually reach all items in this catalog. { "rel": "self", "type": "application/json", - "href": "https://stacserver.org" + "href": "https://stac-api.example.com" }, { "rel": "root", "type": "application/json", - "href": "https://stacserver.org" + "href": "https://stac-api.example.com" }, { "rel": "service-desc", "type": "application/vnd.oai.openapi+json;version=3.0", - "href": "https://stacserver.org/api" + "href": "https://stac-api.example.com/api" }, { "rel": "service-doc", "type": "text/html", - "href": "https://stacserver.org/api.html" + "href": "https://stac-api.example.com/api.html" }, { "rel": "child", "type": "application/json", - "href": "https://stacserver.org/catalogs/sentinel-2", + "href": "https://stac-api.example.com/catalogs/sentinel-2", }, { "rel": "child", "type": "application/json", - "href": "https://stacserver.org/catalogs/landsat-8", + "href": "https://stac-api.example.com/catalogs/landsat-8", } ] } diff --git a/children/README.md b/children/README.md index ec2e4d5e..77969213 100644 --- a/children/README.md +++ b/children/README.md @@ -31,8 +31,8 @@ This conformance class also requires implementation of the link relations in the The following Link relations shall exist in the Landing Page (root). -| **rel** | **href** | **From** | **Description** | -| ---------- | ----------- | --------------- | -------------------------------- | +| **rel** | **href** | **From** | **Description** | +| ---------- | ----------- | ------------------- | -------------------------------- | | `children` | `/children` | STAC API - Children | List of children of this catalog | The following Link relations shall exist in the `/children` endpoint response. @@ -46,9 +46,9 @@ The following Link relations shall exist in the `/children` endpoint response. This conformance class also requires for the endpoints in the [STAC API - Core](../core) conformance class to be implemented. -| Endpoint | Returns | Description | -| ----------- | -------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `/children` | JSON | Object with a list of child Catalogs and Collections | +| Endpoint | Returns | Description | +| ----------- | ------- | ---------------------------------------------------- | +| `/children` | JSON | Object with a list of child Catalogs and Collections | STAC APIs implementing the `STAC API - Children` conformance class must support HTTP GET operation at `/children`, with the return JSON document consisting of an array of all child Catalogs and Collections in a field `children` and an @@ -88,37 +88,37 @@ The STAC API Landing Page should look like the following (note the `child` link { "rel": "self", "type": "application/json", - "href": "https://stacserver.org" + "href": "https://stac-api.example.com" }, { "rel": "root", "type": "application/json", - "href": "https://stacserver.org" + "href": "https://stac-api.example.com" }, { "rel": "service-desc", "type": "application/vnd.oai.openapi+json;version=3.0", - "href": "https://stacserver.org/api" + "href": "https://stac-api.example.com/api" }, { "rel": "service-doc", "type": "text/html", - "href": "https://stacserver.org/api.html" + "href": "https://stac-api.example.com/api.html" }, { "rel": "children", "type": "application/json", - "href": "https://stacserver.org/children", + "href": "https://stac-api.example.com/children", }, { "rel": "child", "type": "application/json", - "href": "https://stacserver.org/catalogs/cool-data", + "href": "https://stac-api.example.com/catalogs/cool-data", }, { "rel": "child", "type": "application/json", - "href": "https://stacserver.org/catalogs/some-other-data", + "href": "https://stac-api.example.com/catalogs/some-other-data", } ] } @@ -149,17 +149,17 @@ The `/children` endpoint response object should look as follows: { "rel": "root", "type": "application/json", - "href": "https://stacserver.org" + "href": "https://stac-api.example.com" }, { "rel": "parent", "type": "application/json", - "href": "https://stacserver.org" + "href": "https://stac-api.example.com" }, { "rel": "self", "type": "application/json", - "href": "https://stacserver.org/catalogs/cool-data" + "href": "https://stac-api.example.com/catalogs/cool-data" } ], }, @@ -183,17 +183,17 @@ The `/children` endpoint response object should look as follows: { "rel": "root", "type": "application/json", - "href": "https://stacserver.org" + "href": "https://stac-api.example.com" }, { "rel": "parent", "type": "application/json", - "href": "https://stacserver.org" + "href": "https://stac-api.example.com" }, { "rel": "self", "type": "application/json", - "href": "https://stacserver.org/catalogs/some-other-data" + "href": "https://stac-api.example.com/catalogs/some-other-data" } ], } @@ -202,12 +202,12 @@ The `/children` endpoint response object should look as follows: { "rel": "root", "type": "application/json", - "href": "https://stacserver.org" + "href": "https://stac-api.example.com" }, { "rel": "self", "type": "application/json", - "href": "https://stacserver.org/children" + "href": "https://stac-api.example.com/children" } ] } diff --git a/collections/README.md b/collections/README.md index 242e4dea..a13f027b 100644 --- a/collections/README.md +++ b/collections/README.md @@ -112,22 +112,22 @@ the links section must include a `self` link, and it must also link to alternate { "rel": "root", "type": "application/json", - "href": "https://myservice.com" + "href": "https://stac-api.example.com" }, { "rel": "parent", "type": "application/json", - "href": "https://myservice.com" + "href": "https://stac-api.example.com" }, { "rel": "self", "type": "application/json", - "href": "https://myservice.com/collections/cool-data" + "href": "https://stac-api.example.com/collections/cool-data" }, { "rel": "items", "type": "application/json", - "href": "https://myservice.com/collections/cool-data/items" + "href": "https://stac-api.example.com/collections/cool-data/items" } ], } @@ -136,12 +136,12 @@ the links section must include a `self` link, and it must also link to alternate { "rel": "root", "type": "application/json", - "href": "https://myservice.com" + "href": "https://stac-api.example.com" }, { "rel": "self", "type": "application/json", - "href": "https://myservice.com/collections" + "href": "https://stac-api.example.com/collections" } ] } diff --git a/core/README.md b/core/README.md index 62cca8b9..efa73ba0 100644 --- a/core/README.md +++ b/core/README.md @@ -143,8 +143,8 @@ class for OpenAPI 3.1, but may in the future. If sub-catalogs are used, it is **recommended** that these use the endpoint `/catalogs/{catalogId}` to avoid conflicting with other endpoints from the root. -| Endpoint | Returns | Description | -| --------------------- | ---------------------------------------------- | -------------------- | +| Endpoint | Returns | Description | +| ----------------------- | ---------------------------------------------- | -------------------- | | `/catalogs/{catalogId}` | [Catalog](../stac-spec/catalog-spec/README.md) | child Catalog object | ## Example Landing Page for STAC API - Core @@ -174,32 +174,32 @@ different conformance classes and a different set of links. { "rel": "self", "type": "application/json", - "href": "https://stacserver.org" + "href": "https://stac-api.example.com" }, { "rel": "root", "type": "application/json", - "href": "https://stacserver.org" + "href": "https://stac-api.example.com" }, { "rel": "service-desc", "type": "application/vnd.oai.openapi+json;version=3.0", - "href": "https://stacserver.org/api" + "href": "https://stac-api.example.com/api" }, { "rel": "service-doc", "type": "text/html", - "href": "https://stacserver.org/api.html" + "href": "https://stac-api.example.com/api.html" }, { "rel": "child", "type": "application/json", - "href": "https://stacserver.org/catalogs/sentinel-2", + "href": "https://stac-api.example.com/catalogs/sentinel-2", }, { "rel": "child", "type": "application/json", - "href": "https://stacserver.org/catalogs/landsat-8", + "href": "https://stac-api.example.com/catalogs/landsat-8", } ] } diff --git a/fragments/filter/README.md b/fragments/filter/README.md index 46a80e92..11f99988 100644 --- a/fragments/filter/README.md +++ b/fragments/filter/README.md @@ -263,7 +263,7 @@ definitions for STAC Items should include at least the fields id, collection, ge ```json { "$schema" : "https://json-schema.org/draft/2019-09/schema", - "$id" : "https://example.org/queryables", + "$id" : "https://stac-api.example.com/queryables", "type" : "object", "title" : "Queryables for Example STAC API", "description" : "Queryable names for the example STAC API Item Search filter.", @@ -328,7 +328,7 @@ in STAC API by the Filter Extension. In this case, the queryables endpoint (`/qu ```json { "$schema" : "https://json-schema.org/draft/2019-09/schema", - "$id" : "https://example.org/queryables", + "$id" : "https://stac-api.example.com/queryables", "type" : "object", "title" : "Queryables for Example STAC API", "description" : "Queryable names for the example STAC API Item Search filter.", @@ -383,13 +383,13 @@ at least these values: "links": [ { "title": "Search", - "href": "https://example.org/search", + "href": "https://stac-api.example.com/search", "rel": "search", "type": "application/geo+json" }, { "title": "Queryables", - "href": "https://example.org/queryables", + "href": "https://stac-api.example.com/queryables", "rel": "http://www.opengis.net/def/rel/ogc/1.0/queryables", "type": "application/schema+json" } @@ -407,7 +407,7 @@ The Queryables endpoint (`/queryables`) returns something like the following: ```json { "$schema" : "https://json-schema.org/draft/2019-09/schema", - "$id" : "https://example.org/queryables", + "$id" : "https://stac-api.example.com/queryables", "type" : "object", "title" : "Queryables for Example STAC API", "description" : "Queryable names for the example STAC API Item Search filter.", @@ -585,7 +585,7 @@ The queryables defined are as follows: ```json { "$schema" : "https://json-schema.org/draft/2019-09/schema", - "$id" : "https://example.org/queryables", + "$id" : "https://stac-api.example.com/queryables", "type" : "object", "title" : "Queryables for Example STAC API", "description" : "Queryable names for the example STAC API Item Search filter.", @@ -740,7 +740,7 @@ This queryables JSON Schema is used in these examples: ```json { "$schema" : "https://json-schema.org/draft/2019-09/schema", - "$id" : "https://example.org/queryables", + "$id" : "https://stac-api.example.com/queryables", "type" : "object", "title" : "Queryables for Example STAC API", "description" : "Queryable names for the example STAC API Item Search filter.", diff --git a/fragments/itemcollection/examples/itemcollection-sample-full.json b/fragments/itemcollection/examples/itemcollection-sample-full.json index dad0c18b..f69dc930 100644 --- a/fragments/itemcollection/examples/itemcollection-sample-full.json +++ b/fragments/itemcollection/examples/itemcollection-sample-full.json @@ -1,87 +1,89 @@ { - "type": "FeatureCollection", - "features": [ - { - "stac_version": "1.0.0", - "stac_extensions": [], - "type": "Feature", - "id": "CS3-20160503_132131_05", - "bbox": [ - -122.59750209, - 37.48803556, - -122.2880486, - 37.613537207 - ], - "geometry": { - "type": "Polygon", - "coordinates": [ - [ - [ - -122.308150179, - 37.488035566 - ], - [ - -122.597502109, - 37.538869539 - ], - [ - -122.576687533, - 37.613537207 - ], - [ - -122.288048600, - 37.562818007 + "type": "FeatureCollection", + "features": [ + { + "stac_version": "1.0.0", + "stac_extensions": [], + "type": "Feature", + "id": "CS3-20160503_132131_05", + "bbox": [ + -122.59750209, + 37.48803556, + -122.2880486, + 37.613537207 ], - [ - -122.308150179, - 37.488035566 - ] - ] - ] - }, - "properties": { - "datetime": "2016-05-03T13:22:30.040Z", - "title": "A CS3 item", - "license": "PDDL-1.0", - "providers": [ - { - "name": "CoolSat", - "roles": [ - "producer", - "licensor" + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + -122.308150179, + 37.488035566 + ], + [ + -122.597502109, + 37.538869539 + ], + [ + -122.576687533, + 37.613537207 + ], + [ + -122.288048600, + 37.562818007 + ], + [ + -122.308150179, + 37.488035566 + ] + ] + ] + }, + "properties": { + "datetime": "2016-05-03T13:22:30.040Z", + "title": "A CS3 item", + "license": "PDDL-1.0", + "providers": [ + { + "name": "CoolSat", + "roles": [ + "producer", + "licensor" + ], + "url": "https://stac-api.example.com" + } + ] + }, + "collection": "CS3", + "links": [ + { + "rel": "self", + "href": "https://stac-api.example.com/catalog/CS3-20160503_132130_04/CS3-20160503_132130_04.json" + }, + { + "rel": "collection", + "href": "https://stac-api.example.com/catalog/CS3-20160503_132130_04/catalog.json" + } ], - "url": "https://cool-sat.com/" - } - ] - }, - "collection": "CS3", - "links": [ - { - "rel": "self", - "href": "http://cool-sat.com/catalog/CS3-20160503_132130_04/CS3-20160503_132130_04.json" - }, - { - "rel": "collection", - "href": "http://cool-sat.com/catalog/CS3-20160503_132130_04/catalog.json" + "assets": { + "analytic": { + "href": "https://stac-api.example.com/catalog/CS3-20160503_132130_04/analytic.tif", + "title": "4-Band Analytic" + }, + "thumbnail": { + "href": "https://stac-api.example.com/catalog/CS3-20160503_132130_04/thumbnail.png", + "title": "Thumbnail", + "roles": [ + "thumbnail" + ] + } + } } - ], - "assets": { - "analytic": { - "href": "http://cool-sat.com/catalog/CS3-20160503_132130_04/analytic.tif", - "title": "4-Band Analytic" - }, - "thumbnail": { - "href": "http://cool-sat.com/catalog/CS3-20160503_132130_04/thumbnail.png", - "title": "Thumbnail", - "roles": [ "thumbnail" ] + ], + "links": [ + { + "rel": "self", + "href": "http://stac.example.com/search?collection=CS3" } - } - } - ], - "links": [ - { - "rel": "self", - "href": "http://stac.example.com/search?collection=CS3" - } - ] -} + ] +} \ No newline at end of file diff --git a/item-search/README.md b/item-search/README.md index 1c43abaa..1874a7de 100644 --- a/item-search/README.md +++ b/item-search/README.md @@ -152,11 +152,11 @@ parameter name is defined by the implementor and is not necessarily part of the "links": [ { "rel": "next", - "href": "http://api.cool-sat.com/search?page=3" + "href": "https://stac-api.example.com/search?page=3" }, { "rel": "prev", - "href": "http://api.cool-sat.com/search?page=1" + "href": "https://stac-api.example.com/search?page=1" } ] } @@ -164,9 +164,9 @@ parameter name is defined by the implementor and is not necessarily part of the The href may contain any arbitrary URL parameter: -- `http://api.cool-sat.com/search?page=2` -- `http://api.cool-sat.com/search?next=8a35eba9c` -- `http://api.cool-sat.com/search?token=f32890a0bdb09ac3` +- `https://stac-api.example.com/search?page=2` +- `https://stac-api.example.com/search?next=8a35eba9c` +- `https://stac-api.example.com/search?token=f32890a0bdb09ac3` Implementations may also add link relations `prev`, `first`, and `last`, though these are not required and may be infeasible to implement in some data stores. @@ -253,33 +253,33 @@ the [overview](../overview.md#example-landing-page) document. { "rel": "self", "type": "application/json", - "href": "https://stacserver.org" + "href": "https://stac-api.example.com" }, { "rel": "root", "type": "application/json", - "href": "https://stacserver.org" + "href": "https://stac-api.example.com" }, { "rel": "service-desc", "type": "application/vnd.oai.openapi+json;version=3.0", - "href": "https://stacserver.org/api" + "href": "https://stac-api.example.com/api" }, { "rel": "service-doc", "type": "text/html", - "href": "https://stacserver.org/api.html" + "href": "https://stac-api.example.com/api.html" }, { "rel": "search", "type": "application/geo+json", - "href": "https://stacserver.org/search", + "href": "https://stac-api.example.com/search", "method": "GET" }, { "rel": "search", "type": "application/geo+json", - "href": "https://stacserver.org/search", + "href": "https://stac-api.example.com/search", "method": "POST" } ] diff --git a/item-search/examples.md b/item-search/examples.md index 96d40cde..40d85a05 100644 --- a/item-search/examples.md +++ b/item-search/examples.md @@ -34,12 +34,12 @@ Response with `200 OK`: "links": [ { "rel": "next", - "href": "http://api.cool-sat.com/search?page=2" + "https://stac-api.example.com/search?page=2" } ] } ``` -Following the link `http://api.cool-sat.com/search?page=2` will send the user to the next page of results. +Following the link `https://stac-api.example.com/search?page=2` will send the user to the next page of results. #### POST search with body and merge fields Request to `HTTP POST /search`: @@ -57,7 +57,7 @@ Response with `200 OK`: "links": [ { "rel": "next", - "href": "http://api.cool-sat.com/search", + "href": "https://stac-api.example.com/search", "method": "POST", "body": { "page": 2, @@ -88,7 +88,7 @@ Response with `200 OK`: ```json { "rel": "next", - "href": "http://api.cool-sat.com/search", + "href": "https://stac-api.example.com/search", "method": "POST", "body": { "next": "a9f3kfbc98e29a0da23" @@ -122,7 +122,7 @@ Response with `200 OK`: "links": [ { "rel": "next", - "href": "http://api.cool-sat.com/search", + "href": "https://stac-api.example.com/search", "method": "POST", "headers": { "Search-After": "LC81530752019135LGN00" diff --git a/ogcapi-features/README.md b/ogcapi-features/README.md index 113a99cf..46642046 100644 --- a/ogcapi-features/README.md +++ b/ogcapi-features/README.md @@ -126,16 +126,16 @@ or `token` and any additional filter parameters if given and required. For examp "links": [ { "rel": "next", - "href": "http://api.cool-sat.com/collections/my_collection/items?page=2" + "href": "https://stac-api.example.com/collections/my_collection/items?page=2" } ] ``` The href may contain any arbitrary URL parameter, which is implementation-specific: -- `http://api.cool-sat.com/collections/my_collection/items?page=2` -- `http://api.cool-sat.com/collections/my_collection/items?next=8a35eba9c` -- `http://api.cool-sat.com/collections/my_collection/items?token=f32890a0bdb09ac3` +- `https://stac-api.example.com/collections/my_collection/items?page=2` +- `https://stac-api.example.com/collections/my_collection/items?next=8a35eba9c` +- `https://stac-api.example.com/collections/my_collection/items?token=f32890a0bdb09ac3` In addition to supporting query parameters in the URL value of the `href` field, STAC has extended the Link object @@ -175,11 +175,11 @@ previous (page=2) pages: ... { "rel": "prev", - "href": "http://api.cool-sat.com/collections?page=2" + "href": "https://stac-api.example.com/collections?page=2" }, { "rel": "next", - "href": "http://api.cool-sat.com/collections?page=4" + "href": "https://stac-api.example.com/collections?page=4" } ] ``` @@ -252,32 +252,32 @@ the [overview](../overview.md#example-landing-page) document. { "rel": "self", "type": "application/json", - "href": "https://stacserver.org" + "href": "https://stac-api.example.com" }, { "rel": "root", "type": "application/json", - "href": "https://stacserver.org" + "href": "https://stac-api.example.com" }, { "rel": "conformance", "type": "application/json", - "href": "https://stacserver.org/conformance" + "href": "https://stac-api.example.com/conformance" }, { "rel": "service-desc", "type": "application/vnd.oai.openapi+json;version=3.0", - "href": "https://stacserver.org/api" + "href": "https://stac-api.example.com/api" }, { "rel": "service-doc", "type": "text/html", - "href": "https://stacserver.org/api.html" + "href": "https://stac-api.example.com/api.html" }, { "rel": "data", "type": "application/json", - "href": "https://stacserver.org/collections" + "href": "https://stac-api.example.com/collections" } ] } @@ -289,7 +289,7 @@ The landing page `data` relation points to an endpoint to retrieve all collectio a link relation to its `items` resource through the link with a rel value `items`. Note here that, unlike as is typical with a static STAC Collection, there are no links here with rel value `item`. -`https://stacserver.org/collections/aster-l1t` +`https://stac-api.example.com/collections/aster-l1t` ```json { @@ -300,22 +300,22 @@ as is typical with a static STAC Collection, there are no links here with rel va { "rel": "items", "type": "application/geo+json", - "href": "https://stacserver.org/collections/aster-l1t/items" + "href": "https://stac-api.example.com/collections/aster-l1t/items" }, { "rel": "parent", "type": "application/json", - "href": "https://stacserver.org" + "href": "https://stac-api.example.com" }, { "rel": "root", "type": "application/json", - "href": "https://stacserver.org" + "href": "https://stac-api.example.com" }, { "rel": "self", "type": "application/json", - "href": "https://stacserver.org/collections/aster-l1t" + "href": "https://stac-api.example.com/collections/aster-l1t" } ] } diff --git a/overview.md b/overview.md index d17774b0..04f0b290 100644 --- a/overview.md +++ b/overview.md @@ -112,7 +112,7 @@ column is more of an example in some cases. OGC API makes some endpoint location | `/search` | [Item Search](item-search) | search | [ItemCollection](fragments/itemcollection/README.md) | Retrieves a group of Item objects matching the provided search predicates, probably containing search metadata from the `search` extension | | **`/collections`** | [OAFeat](ogcapi-features) | data | JSON | Object with a list of Collection objects contained in the catalog and links | | **`/conformance`** | [OAFeat](ogcapi-features) | conformance | JSON | Info about standards to which the API conforms | -| `/api` | [OAFeat](ogcapi-features) | service-desc | any | The description of the endpoints in this service | +| `/api` | [OAFeat](ogcapi-features) | service-desc | any | The description of the endpoints in this service | | **`/collections/{collectionId}`** | [OAFeat](ogcapi-features) | collection | Collection | Returns single Collection JSON | | **`/collections/{collectionId}/items`** | [OAFeat](ogcapi-features) | items | ItemCollection | GeoJSON FeatureCollection-conformant entity of Item objects in collection | | **`/collections/{collectionId}/items/{featureId}`** | [OAFeat](ogcapi-features) | item | Returns single Item (GeoJSON Feature). This relation is usually not used in OAFeat implementations. | @@ -176,47 +176,47 @@ The Landing Page will at least have the following `conformsTo` and `links`: { "rel": "self", "type": "application/json", - "href": "https://stacserver.org" + "href": "https://stac-api.example.com" }, { "rel": "root", "type": "application/json", - "href": "https://stacserver.org" + "href": "https://stac-api.example.com" }, { "rel": "conformance", "type": "application/json", - "href": "https://stacserver.org/conformance" + "href": "https://stac-api.example.com/conformance" }, { "rel": "service-desc", "type": "application/vnd.oai.openapi+json;version=3.0", - "href": "https://stacserver.org/api" + "href": "https://stac-api.example.com/api" }, { "rel": "service-doc", "type": "text/html", - "href": "https://stacserver.org/api.html" + "href": "https://stac-api.example.com/api.html" }, { "rel": "data", "type": "application/json", - "href": "https://stacserver.org/collections" + "href": "https://stac-api.example.com/collections" }, { "rel": "child", "type": "application/json", - "href": "https://stacserver.org/collections/sentinel-2", + "href": "https://stac-api.example.com/collections/sentinel-2", }, { "rel": "child", "type": "application/json", - "href": "https://stacserver.org/collections/landsat-8", + "href": "https://stac-api.example.com/collections/landsat-8", }, { "rel": "search", "type": "application/geo+json", - "href": "https://stacserver.org/search" + "href": "https://stac-api.example.com/search" } ] }