Skip to content

Commit 7fabce4

Browse files
philvarnerphilvarner
authored
update example urls to stac-api.example.com (#264)
1 parent 32c3d83 commit 7fabce4

File tree

10 files changed

+174
-172
lines changed

10 files changed

+174
-172
lines changed

‎browseable/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -70,32 +70,32 @@ eventually reach all items in this catalog.
7070
{
7171
"rel": "self",
7272
"type": "application/json",
73-
"href": "https://stacserver.org"
73+
"href": "https://stac-api.example.com"
7474
},
7575
{
7676
"rel": "root",
7777
"type": "application/json",
78-
"href": "https://stacserver.org"
78+
"href": "https://stac-api.example.com"
7979
},
8080
{
8181
"rel": "service-desc",
8282
"type": "application/vnd.oai.openapi+json;version=3.0",
83-
"href": "https://stacserver.org/api"
83+
"href": "https://stac-api.example.com/api"
8484
},
8585
{
8686
"rel": "service-doc",
8787
"type": "text/html",
88-
"href": "https://stacserver.org/api.html"
88+
"href": "https://stac-api.example.com/api.html"
8989
},
9090
{
9191
"rel": "child",
9292
"type": "application/json",
93-
"href": "https://stacserver.org/catalogs/sentinel-2",
93+
"href": "https://stac-api.example.com/catalogs/sentinel-2",
9494
},
9595
{
9696
"rel": "child",
9797
"type": "application/json",
98-
"href": "https://stacserver.org/catalogs/landsat-8",
98+
"href": "https://stac-api.example.com/catalogs/landsat-8",
9999
}
100100
]
101101
}

‎children/README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ This conformance class also requires implementation of the link relations in the
3131

3232
The following Link relations shall exist in the Landing Page (root).
3333

34-
| **rel** | **href** | **From** | **Description** |
35-
| ---------- | ----------- | --------------- | -------------------------------- |
34+
| **rel** | **href** | **From** | **Description** |
35+
| ---------- | ----------- | ------------------- | -------------------------------- |
3636
| `children` | `/children` | STAC API - Children | List of children of this catalog |
3737

3838
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.
4646

4747
This conformance class also requires for the endpoints in the [STAC API - Core](../core) conformance class to be implemented.
4848

49-
| Endpoint | Returns | Description |
50-
| ----------- | -------------- | ---------------------------------------------------------------------------------------------------------------------- |
51-
| `/children` | JSON | Object with a list of child Catalogs and Collections |
49+
| Endpoint | Returns | Description |
50+
| ----------- | ------- | ---------------------------------------------------- |
51+
| `/children` | JSON | Object with a list of child Catalogs and Collections |
5252

5353
STAC APIs implementing the `STAC API - Children` conformance class must support HTTP GET operation at
5454
`/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
8888
{
8989
"rel": "self",
9090
"type": "application/json",
91-
"href": "https://stacserver.org"
91+
"href": "https://stac-api.example.com"
9292
},
9393
{
9494
"rel": "root",
9595
"type": "application/json",
96-
"href": "https://stacserver.org"
96+
"href": "https://stac-api.example.com"
9797
},
9898
{
9999
"rel": "service-desc",
100100
"type": "application/vnd.oai.openapi+json;version=3.0",
101-
"href": "https://stacserver.org/api"
101+
"href": "https://stac-api.example.com/api"
102102
},
103103
{
104104
"rel": "service-doc",
105105
"type": "text/html",
106-
"href": "https://stacserver.org/api.html"
106+
"href": "https://stac-api.example.com/api.html"
107107
},
108108
{
109109
"rel": "children",
110110
"type": "application/json",
111-
"href": "https://stacserver.org/children",
111+
"href": "https://stac-api.example.com/children",
112112
},
113113
{
114114
"rel": "child",
115115
"type": "application/json",
116-
"href": "https://stacserver.org/catalogs/cool-data",
116+
"href": "https://stac-api.example.com/catalogs/cool-data",
117117
},
118118
{
119119
"rel": "child",
120120
"type": "application/json",
121-
"href": "https://stacserver.org/catalogs/some-other-data",
121+
"href": "https://stac-api.example.com/catalogs/some-other-data",
122122
}
123123
]
124124
}
@@ -149,17 +149,17 @@ The `/children` endpoint response object should look as follows:
149149
{
150150
"rel": "root",
151151
"type": "application/json",
152-
"href": "https://stacserver.org"
152+
"href": "https://stac-api.example.com"
153153
},
154154
{
155155
"rel": "parent",
156156
"type": "application/json",
157-
"href": "https://stacserver.org"
157+
"href": "https://stac-api.example.com"
158158
},
159159
{
160160
"rel": "self",
161161
"type": "application/json",
162-
"href": "https://stacserver.org/catalogs/cool-data"
162+
"href": "https://stac-api.example.com/catalogs/cool-data"
163163
}
164164
],
165165
},
@@ -183,17 +183,17 @@ The `/children` endpoint response object should look as follows:
183183
{
184184
"rel": "root",
185185
"type": "application/json",
186-
"href": "https://stacserver.org"
186+
"href": "https://stac-api.example.com"
187187
},
188188
{
189189
"rel": "parent",
190190
"type": "application/json",
191-
"href": "https://stacserver.org"
191+
"href": "https://stac-api.example.com"
192192
},
193193
{
194194
"rel": "self",
195195
"type": "application/json",
196-
"href": "https://stacserver.org/catalogs/some-other-data"
196+
"href": "https://stac-api.example.com/catalogs/some-other-data"
197197
}
198198
],
199199
}
@@ -202,12 +202,12 @@ The `/children` endpoint response object should look as follows:
202202
{
203203
"rel": "root",
204204
"type": "application/json",
205-
"href": "https://stacserver.org"
205+
"href": "https://stac-api.example.com"
206206
},
207207
{
208208
"rel": "self",
209209
"type": "application/json",
210-
"href": "https://stacserver.org/children"
210+
"href": "https://stac-api.example.com/children"
211211
}
212212
]
213213
}

‎collections/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -112,22 +112,22 @@ the links section must include a `self` link, and it must also link to alternate
112112
{
113113
"rel": "root",
114114
"type": "application/json",
115-
"href": "https://myservice.com"
115+
"href": "https://stac-api.example.com"
116116
},
117117
{
118118
"rel": "parent",
119119
"type": "application/json",
120-
"href": "https://myservice.com"
120+
"href": "https://stac-api.example.com"
121121
},
122122
{
123123
"rel": "self",
124124
"type": "application/json",
125-
"href": "https://myservice.com/collections/cool-data"
125+
"href": "https://stac-api.example.com/collections/cool-data"
126126
},
127127
{
128128
"rel": "items",
129129
"type": "application/json",
130-
"href": "https://myservice.com/collections/cool-data/items"
130+
"href": "https://stac-api.example.com/collections/cool-data/items"
131131
}
132132
],
133133
}
@@ -136,12 +136,12 @@ the links section must include a `self` link, and it must also link to alternate
136136
{
137137
"rel": "root",
138138
"type": "application/json",
139-
"href": "https://myservice.com"
139+
"href": "https://stac-api.example.com"
140140
},
141141
{
142142
"rel": "self",
143143
"type": "application/json",
144-
"href": "https://myservice.com/collections"
144+
"href": "https://stac-api.example.com/collections"
145145
}
146146
]
147147
}

‎core/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -143,8 +143,8 @@ class for OpenAPI 3.1, but may in the future.
143143
If sub-catalogs are used, it is **recommended** that these use the endpoint `/catalogs/{catalogId}` to avoid conflicting
144144
with other endpoints from the root.
145145

146-
| Endpoint | Returns | Description |
147-
| --------------------- | ---------------------------------------------- | -------------------- |
146+
| Endpoint | Returns | Description |
147+
| ----------------------- | ---------------------------------------------- | -------------------- |
148148
| `/catalogs/{catalogId}` | [Catalog](../stac-spec/catalog-spec/README.md) | child Catalog object |
149149

150150
## Example Landing Page for STAC API - Core
@@ -174,32 +174,32 @@ different conformance classes and a different set of links.
174174
{
175175
"rel": "self",
176176
"type": "application/json",
177-
"href": "https://stacserver.org"
177+
"href": "https://stac-api.example.com"
178178
},
179179
{
180180
"rel": "root",
181181
"type": "application/json",
182-
"href": "https://stacserver.org"
182+
"href": "https://stac-api.example.com"
183183
},
184184
{
185185
"rel": "service-desc",
186186
"type": "application/vnd.oai.openapi+json;version=3.0",
187-
"href": "https://stacserver.org/api"
187+
"href": "https://stac-api.example.com/api"
188188
},
189189
{
190190
"rel": "service-doc",
191191
"type": "text/html",
192-
"href": "https://stacserver.org/api.html"
192+
"href": "https://stac-api.example.com/api.html"
193193
},
194194
{
195195
"rel": "child",
196196
"type": "application/json",
197-
"href": "https://stacserver.org/catalogs/sentinel-2",
197+
"href": "https://stac-api.example.com/catalogs/sentinel-2",
198198
},
199199
{
200200
"rel": "child",
201201
"type": "application/json",
202-
"href": "https://stacserver.org/catalogs/landsat-8",
202+
"href": "https://stac-api.example.com/catalogs/landsat-8",
203203
}
204204
]
205205
}

‎fragments/filter/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ definitions for STAC Items should include at least the fields id, collection, ge
263263
```json
264264
{
265265
"$schema" : "https://json-schema.org/draft/2019-09/schema",
266-
"$id" : "https://example.org/queryables",
266+
"$id" : "https://stac-api.example.com/queryables",
267267
"type" : "object",
268268
"title" : "Queryables for Example STAC API",
269269
"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
328328
```json
329329
{
330330
"$schema" : "https://json-schema.org/draft/2019-09/schema",
331-
"$id" : "https://example.org/queryables",
331+
"$id" : "https://stac-api.example.com/queryables",
332332
"type" : "object",
333333
"title" : "Queryables for Example STAC API",
334334
"description" : "Queryable names for the example STAC API Item Search filter.",
@@ -383,13 +383,13 @@ at least these values:
383383
"links": [
384384
{
385385
"title": "Search",
386-
"href": "https://example.org/search",
386+
"href": "https://stac-api.example.com/search",
387387
"rel": "search",
388388
"type": "application/geo+json"
389389
},
390390
{
391391
"title": "Queryables",
392-
"href": "https://example.org/queryables",
392+
"href": "https://stac-api.example.com/queryables",
393393
"rel": "http://www.opengis.net/def/rel/ogc/1.0/queryables",
394394
"type": "application/schema+json"
395395
}
@@ -407,7 +407,7 @@ The Queryables endpoint (`/queryables`) returns something like the following:
407407
```json
408408
{
409409
"$schema" : "https://json-schema.org/draft/2019-09/schema",
410-
"$id" : "https://example.org/queryables",
410+
"$id" : "https://stac-api.example.com/queryables",
411411
"type" : "object",
412412
"title" : "Queryables for Example STAC API",
413413
"description" : "Queryable names for the example STAC API Item Search filter.",
@@ -585,7 +585,7 @@ The queryables defined are as follows:
585585
```json
586586
{
587587
"$schema" : "https://json-schema.org/draft/2019-09/schema",
588-
"$id" : "https://example.org/queryables",
588+
"$id" : "https://stac-api.example.com/queryables",
589589
"type" : "object",
590590
"title" : "Queryables for Example STAC API",
591591
"description" : "Queryable names for the example STAC API Item Search filter.",
@@ -740,7 +740,7 @@ This queryables JSON Schema is used in these examples:
740740
```json
741741
{
742742
"$schema" : "https://json-schema.org/draft/2019-09/schema",
743-
"$id" : "https://example.org/queryables",
743+
"$id" : "https://stac-api.example.com/queryables",
744744
"type" : "object",
745745
"title" : "Queryables for Example STAC API",
746746
"description" : "Queryable names for the example STAC API Item Search filter.",

0 commit comments

Comments
 (0)