Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update example urls #264

Merged
merged 1 commit into from
Mar 3, 2022
Merged

Update example urls #264

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions browseable/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
}
]
}
Expand Down
40 changes: 20 additions & 20 deletions children/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down Expand Up @@ -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",
}
]
}
Expand Down Expand Up @@ -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"
}
],
},
Expand All @@ -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"
}
],
}
Expand All @@ -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"
}
]
}
Expand Down
12 changes: 6 additions & 6 deletions collections/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
],
}
Expand All @@ -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"
}
]
}
Expand Down
16 changes: 8 additions & 8 deletions core/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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",
}
]
}
Expand Down
14 changes: 7 additions & 7 deletions fragments/filter/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.",
Expand Down Expand Up @@ -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.",
Expand Down Expand Up @@ -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"
}
Expand All @@ -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.",
Expand Down Expand Up @@ -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.",
Expand Down Expand Up @@ -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.",
Expand Down
Loading