eodag 3.10.1__py3-none-any.whl → 4.0.0a2__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- eodag/__init__.py +6 -1
- eodag/api/collection.py +353 -0
- eodag/api/core.py +606 -641
- eodag/api/product/__init__.py +3 -3
- eodag/api/product/_product.py +74 -56
- eodag/api/product/drivers/__init__.py +4 -46
- eodag/api/product/drivers/base.py +0 -28
- eodag/api/product/metadata_mapping.py +178 -216
- eodag/api/search_result.py +156 -15
- eodag/cli.py +83 -403
- eodag/config.py +81 -51
- eodag/plugins/apis/base.py +2 -2
- eodag/plugins/apis/ecmwf.py +36 -25
- eodag/plugins/apis/usgs.py +55 -40
- eodag/plugins/authentication/base.py +1 -3
- eodag/plugins/crunch/filter_date.py +3 -3
- eodag/plugins/crunch/filter_latest_intersect.py +2 -2
- eodag/plugins/crunch/filter_latest_tpl_name.py +1 -1
- eodag/plugins/download/aws.py +46 -42
- eodag/plugins/download/base.py +13 -14
- eodag/plugins/download/http.py +65 -65
- eodag/plugins/manager.py +28 -29
- eodag/plugins/search/__init__.py +6 -4
- eodag/plugins/search/base.py +131 -80
- eodag/plugins/search/build_search_result.py +245 -173
- eodag/plugins/search/cop_marine.py +87 -56
- eodag/plugins/search/csw.py +47 -37
- eodag/plugins/search/qssearch.py +653 -429
- eodag/plugins/search/stac_list_assets.py +1 -1
- eodag/plugins/search/static_stac_search.py +43 -44
- eodag/resources/{product_types.yml → collections.yml} +2594 -2453
- eodag/resources/ext_collections.json +1 -1
- eodag/resources/ext_product_types.json +1 -1
- eodag/resources/providers.yml +2706 -2733
- eodag/resources/stac_provider.yml +50 -92
- eodag/resources/user_conf_template.yml +9 -0
- eodag/types/__init__.py +2 -0
- eodag/types/queryables.py +70 -91
- eodag/types/search_args.py +1 -1
- eodag/utils/__init__.py +97 -21
- eodag/utils/dates.py +0 -12
- eodag/utils/exceptions.py +6 -6
- eodag/utils/free_text_search.py +3 -3
- eodag/utils/repr.py +2 -0
- {eodag-3.10.1.dist-info → eodag-4.0.0a2.dist-info}/METADATA +13 -99
- eodag-4.0.0a2.dist-info/RECORD +93 -0
- {eodag-3.10.1.dist-info → eodag-4.0.0a2.dist-info}/entry_points.txt +0 -4
- eodag/plugins/authentication/oauth.py +0 -60
- eodag/plugins/download/creodias_s3.py +0 -71
- eodag/plugins/download/s3rest.py +0 -351
- eodag/plugins/search/data_request_search.py +0 -565
- eodag/resources/stac.yml +0 -294
- eodag/resources/stac_api.yml +0 -2105
- eodag/rest/__init__.py +0 -24
- eodag/rest/cache.py +0 -70
- eodag/rest/config.py +0 -67
- eodag/rest/constants.py +0 -26
- eodag/rest/core.py +0 -764
- eodag/rest/errors.py +0 -210
- eodag/rest/server.py +0 -604
- eodag/rest/server.wsgi +0 -6
- eodag/rest/stac.py +0 -1032
- eodag/rest/templates/README +0 -1
- eodag/rest/types/__init__.py +0 -18
- eodag/rest/types/collections_search.py +0 -44
- eodag/rest/types/eodag_search.py +0 -386
- eodag/rest/types/queryables.py +0 -174
- eodag/rest/types/stac_search.py +0 -272
- eodag/rest/utils/__init__.py +0 -207
- eodag/rest/utils/cql_evaluate.py +0 -119
- eodag/rest/utils/rfc3339.py +0 -64
- eodag-3.10.1.dist-info/RECORD +0 -116
- {eodag-3.10.1.dist-info → eodag-4.0.0a2.dist-info}/WHEEL +0 -0
- {eodag-3.10.1.dist-info → eodag-4.0.0a2.dist-info}/licenses/LICENSE +0 -0
- {eodag-3.10.1.dist-info → eodag-4.0.0a2.dist-info}/top_level.txt +0 -0
eodag/resources/stac_api.yml
DELETED
|
@@ -1,2105 +0,0 @@
|
|
|
1
|
-
openapi: 3.0.1
|
|
2
|
-
info:
|
|
3
|
-
title: The SpatioTemporal Asset Catalog API
|
|
4
|
-
version: 1.0.0
|
|
5
|
-
license:
|
|
6
|
-
name: Apache License 2.0
|
|
7
|
-
url: 'http://www.apache.org/licenses/LICENSE-2.0'
|
|
8
|
-
description: >-
|
|
9
|
-
This is an OpenAPI definition of the core SpatioTemporal Asset Catalog API
|
|
10
|
-
specification. Any service that implements this endpoint to allow search of
|
|
11
|
-
spatiotemporal assets can be considered a STAC API. The endpoint is also
|
|
12
|
-
available as an OpenAPI fragment that can be integrated with other OpenAPI
|
|
13
|
-
definitions, and is designed to slot seamlessly into a OGC API - Features
|
|
14
|
-
definition.
|
|
15
|
-
contact:
|
|
16
|
-
name: STAC Specification
|
|
17
|
-
url: 'http://stacspec.org'
|
|
18
|
-
paths:
|
|
19
|
-
/:
|
|
20
|
-
get:
|
|
21
|
-
tags:
|
|
22
|
-
- Capabilities
|
|
23
|
-
summary: STAC API landing page
|
|
24
|
-
description: |-
|
|
25
|
-
Returns the root STAC Catalog or STAC Collection that is the entry point
|
|
26
|
-
for users to browse with STAC Browser or for search engines to crawl.
|
|
27
|
-
This can either return a single STAC Collection or more commonly a STAC
|
|
28
|
-
catalog.
|
|
29
|
-
|
|
30
|
-
The landing page provides links to the API definition, the conformance
|
|
31
|
-
statements, the collections and sub-catalogs.
|
|
32
|
-
operationId: getLandingPage
|
|
33
|
-
responses:
|
|
34
|
-
'200':
|
|
35
|
-
$ref: '#/components/responses/LandingPage'
|
|
36
|
-
'500':
|
|
37
|
-
$ref: '#/components/responses/ServerError'
|
|
38
|
-
/api:
|
|
39
|
-
get:
|
|
40
|
-
tags:
|
|
41
|
-
- Capabilities
|
|
42
|
-
summary: Eodag Openapi
|
|
43
|
-
description: Customized openapi
|
|
44
|
-
operationId: eodag_openapi_api_get
|
|
45
|
-
responses:
|
|
46
|
-
'200':
|
|
47
|
-
description: Successful response
|
|
48
|
-
content:
|
|
49
|
-
application/json:
|
|
50
|
-
schema:
|
|
51
|
-
type: object
|
|
52
|
-
/conformance:
|
|
53
|
-
get:
|
|
54
|
-
tags:
|
|
55
|
-
- Capabilities
|
|
56
|
-
summary: information about specifications that this API conforms to
|
|
57
|
-
description: |-
|
|
58
|
-
A list of all conformance classes specified in a standard that the
|
|
59
|
-
server conforms to.
|
|
60
|
-
operationId: getConformanceDeclaration
|
|
61
|
-
responses:
|
|
62
|
-
'200':
|
|
63
|
-
$ref: '#/components/responses/ConformanceDeclaration'
|
|
64
|
-
'500':
|
|
65
|
-
$ref: '#/components/responses/ServerError'
|
|
66
|
-
/queryables:
|
|
67
|
-
get:
|
|
68
|
-
tags:
|
|
69
|
-
- Capabilities
|
|
70
|
-
responses:
|
|
71
|
-
'200':
|
|
72
|
-
$ref: '#/components/responses/Queryables'
|
|
73
|
-
'500':
|
|
74
|
-
$ref: '#/components/responses/ServerError'
|
|
75
|
-
summary: Get the JSON Schema queryables that apply to all collections.
|
|
76
|
-
operationId: getQueryables
|
|
77
|
-
description: |-
|
|
78
|
-
The Queryables mechanism allows a client to discover what terms are available
|
|
79
|
-
for use when writing filter expressions. These terms are defined over the entire catalog.
|
|
80
|
-
|
|
81
|
-
The decision as to which queryables to define for the entire catalog is at the discretion
|
|
82
|
-
of the implementer, and can be anywhere between none and the union of all queryables
|
|
83
|
-
cross all collections.
|
|
84
|
-
/catalogs/{catalogPath}:
|
|
85
|
-
get:
|
|
86
|
-
tags:
|
|
87
|
-
- Capabilities
|
|
88
|
-
summary: Provide details about a given catalog
|
|
89
|
-
description: |-
|
|
90
|
-
Detail the contents in the given catalog provided with `catalogPath`.
|
|
91
|
-
parameters:
|
|
92
|
-
- $ref: '#/components/parameters/catalogPath'
|
|
93
|
-
responses:
|
|
94
|
-
'200':
|
|
95
|
-
description: The catalog's description
|
|
96
|
-
content:
|
|
97
|
-
application/json:
|
|
98
|
-
schema:
|
|
99
|
-
$ref: '#/components/schemas/collection'
|
|
100
|
-
'500':
|
|
101
|
-
$ref: '#/components/responses/ServerError'
|
|
102
|
-
/catalogs/{catalogPath}/items:
|
|
103
|
-
get:
|
|
104
|
-
tags:
|
|
105
|
-
- Data
|
|
106
|
-
summary: List features in a given catalog
|
|
107
|
-
description: |-
|
|
108
|
-
Fetch features in the given catalog provided with `catalogPath`.
|
|
109
|
-
parameters:
|
|
110
|
-
- $ref: '#/components/parameters/provider'
|
|
111
|
-
- $ref: '#/components/parameters/catalogPath'
|
|
112
|
-
- $ref: '#/components/parameters/bbox'
|
|
113
|
-
- $ref: '#/components/parameters/datetime'
|
|
114
|
-
- $ref: '#/components/parameters/limit'
|
|
115
|
-
responses:
|
|
116
|
-
'200':
|
|
117
|
-
description: The list of items found for the given catalog.
|
|
118
|
-
type: array
|
|
119
|
-
content:
|
|
120
|
-
application/json:
|
|
121
|
-
schema:
|
|
122
|
-
$ref: '#/components/schemas/itemCollection'
|
|
123
|
-
'500':
|
|
124
|
-
$ref: '#/components/responses/ServerError'
|
|
125
|
-
/catalogs/{catalogPath}/items/{featureId}:
|
|
126
|
-
get:
|
|
127
|
-
tags:
|
|
128
|
-
- Data
|
|
129
|
-
summary: fetch a single feature from a catalog
|
|
130
|
-
description: |-
|
|
131
|
-
Fetch the feature with id `featureId` in the given catalog provided
|
|
132
|
-
with `cataloPath`.
|
|
133
|
-
parameters:
|
|
134
|
-
- $ref: '#/components/parameters/provider'
|
|
135
|
-
- $ref: '#/components/parameters/catalogPath'
|
|
136
|
-
- $ref: '#/components/parameters/featureId'
|
|
137
|
-
responses:
|
|
138
|
-
'200':
|
|
139
|
-
$ref: '#/components/responses/Feature'
|
|
140
|
-
'404':
|
|
141
|
-
$ref: '#/components/responses/NotFound'
|
|
142
|
-
'500':
|
|
143
|
-
$ref: '#/components/responses/ServerError'
|
|
144
|
-
/catalogs/{catalogPath}/items/{featureId}/download:
|
|
145
|
-
get:
|
|
146
|
-
tags:
|
|
147
|
-
- Data
|
|
148
|
-
summary: download a single feature from a catalog
|
|
149
|
-
description: |-
|
|
150
|
-
Download the feature with id `featureId` in the given catalog provided
|
|
151
|
-
with `catalogPath`.
|
|
152
|
-
parameters:
|
|
153
|
-
- $ref: '#/components/parameters/provider'
|
|
154
|
-
- $ref: '#/components/parameters/catalogPath'
|
|
155
|
-
- $ref: '#/components/parameters/featureId'
|
|
156
|
-
responses:
|
|
157
|
-
'200':
|
|
158
|
-
description: Successful `application/zip` response
|
|
159
|
-
content:
|
|
160
|
-
application/octet-stream:
|
|
161
|
-
schema:
|
|
162
|
-
type: string
|
|
163
|
-
format: binary
|
|
164
|
-
'404':
|
|
165
|
-
$ref: '#/components/responses/NotFound'
|
|
166
|
-
'500':
|
|
167
|
-
$ref: '#/components/responses/ServerError'
|
|
168
|
-
/collections:
|
|
169
|
-
get:
|
|
170
|
-
tags:
|
|
171
|
-
- Capabilities
|
|
172
|
-
summary: The feature collections in the dataset.
|
|
173
|
-
description: A body of Feature Collections that belong or are used together with additional links. Request may not return the full set of metadata per Feature Collection.
|
|
174
|
-
operationId: getCollections
|
|
175
|
-
parameters:
|
|
176
|
-
- $ref: '#/components/parameters/provider'
|
|
177
|
-
- $ref: '#/components/parameters/q'
|
|
178
|
-
responses:
|
|
179
|
-
'200':
|
|
180
|
-
$ref: '#/components/responses/Collections'
|
|
181
|
-
'202':
|
|
182
|
-
$ref: '#/components/responses/Accepted'
|
|
183
|
-
'500':
|
|
184
|
-
$ref: '#/components/responses/ServerError'
|
|
185
|
-
/collections/{collectionId}:
|
|
186
|
-
get:
|
|
187
|
-
tags:
|
|
188
|
-
- Capabilities
|
|
189
|
-
parameters:
|
|
190
|
-
- $ref: '#/components/parameters/collectionId'
|
|
191
|
-
summary: Describe the feature Collection for the given `collectionId`.
|
|
192
|
-
description: A single Feature Colletion for the given `collectionId`. Request this endpoint to get a full list of metadata for the Feature Collection.
|
|
193
|
-
operationId: describeCollection
|
|
194
|
-
responses:
|
|
195
|
-
'200':
|
|
196
|
-
$ref: '#/components/responses/Collection'
|
|
197
|
-
'404':
|
|
198
|
-
$ref: '#/components/responses/NotFound'
|
|
199
|
-
'500':
|
|
200
|
-
$ref: '#/components/responses/ServerError'
|
|
201
|
-
/collections/{collectionId}/queryables:
|
|
202
|
-
get:
|
|
203
|
-
tags:
|
|
204
|
-
- Capabilities
|
|
205
|
-
parameters:
|
|
206
|
-
- $ref: '#/components/parameters/collectionId'
|
|
207
|
-
- $ref: '#/components/parameters/provider'
|
|
208
|
-
- $ref: '#/components/parameters/queryablesAdditionalParameters'
|
|
209
|
-
summary: Get the JSON Schema queryables that apply to a given collection.
|
|
210
|
-
operationId: getQueryablesForCollection
|
|
211
|
-
description: |-
|
|
212
|
-
The Queryables mechanism allows a client to discover what terms are available
|
|
213
|
-
for use when writing filter expressions. These terms are defined per collection.
|
|
214
|
-
|
|
215
|
-
When used as a subresource of the collection resource,
|
|
216
|
-
it returns queryables pertaining only to that single collection.
|
|
217
|
-
|
|
218
|
-
If no provider is given, the intersection of the queryables of all providers available for this collection will
|
|
219
|
-
be returned.
|
|
220
|
-
|
|
221
|
-
If the selected provider (or an available provider if no provider is selected) provides constraints which define
|
|
222
|
-
which value is possible for which parameter, these constraints will be used to derive queryables.
|
|
223
|
-
|
|
224
|
-
responses:
|
|
225
|
-
'200':
|
|
226
|
-
$ref: '#/components/responses/Queryables'
|
|
227
|
-
'404':
|
|
228
|
-
$ref: '#/components/responses/NotFound'
|
|
229
|
-
'500':
|
|
230
|
-
$ref: '#/components/responses/ServerError'
|
|
231
|
-
/collections/{collectionId}/items:
|
|
232
|
-
get:
|
|
233
|
-
tags:
|
|
234
|
-
- Data
|
|
235
|
-
parameters:
|
|
236
|
-
- $ref: '#/components/parameters/provider'
|
|
237
|
-
- $ref: '#/components/parameters/collectionId'
|
|
238
|
-
- $ref: '#/components/parameters/bbox'
|
|
239
|
-
- $ref: '#/components/parameters/datetime'
|
|
240
|
-
- $ref: '#/components/parameters/limit'
|
|
241
|
-
- $ref: '#/components/parameters/ids'
|
|
242
|
-
description: |-
|
|
243
|
-
Fetch features of the feature collection with id `collectionId`.
|
|
244
|
-
|
|
245
|
-
Every feature in a dataset belongs to a collection. A dataset may
|
|
246
|
-
consist of multiple feature collections. A feature collection is often a
|
|
247
|
-
collection of features of a similar type, based on a common schema.
|
|
248
|
-
|
|
249
|
-
Use content negotiation to request HTML or GeoJSON.
|
|
250
|
-
summary: List of items available in a given collection
|
|
251
|
-
operationId: getFeatures
|
|
252
|
-
responses:
|
|
253
|
-
'200':
|
|
254
|
-
$ref: '#/components/responses/Features'
|
|
255
|
-
'400':
|
|
256
|
-
$ref: '#/components/responses/InvalidParameter'
|
|
257
|
-
'404':
|
|
258
|
-
$ref: '#/components/responses/NotFound'
|
|
259
|
-
'500':
|
|
260
|
-
$ref: '#/components/responses/ServerError'
|
|
261
|
-
/collections/{collectionId}/items/{featureId}:
|
|
262
|
-
get:
|
|
263
|
-
tags:
|
|
264
|
-
- Data
|
|
265
|
-
parameters:
|
|
266
|
-
- $ref: '#/components/parameters/provider'
|
|
267
|
-
- $ref: '#/components/parameters/collectionId'
|
|
268
|
-
- $ref: '#/components/parameters/featureId'
|
|
269
|
-
summary: fetch a single feature
|
|
270
|
-
description: |-
|
|
271
|
-
Fetch the feature with id `featureId` in the feature collection
|
|
272
|
-
with id `collectionId`.
|
|
273
|
-
|
|
274
|
-
Use content negotiation to request HTML or GeoJSON.
|
|
275
|
-
operationId: getFeature
|
|
276
|
-
responses:
|
|
277
|
-
'200':
|
|
278
|
-
$ref: '#/components/responses/Feature'
|
|
279
|
-
'404':
|
|
280
|
-
$ref: '#/components/responses/NotFound'
|
|
281
|
-
'500':
|
|
282
|
-
$ref: '#/components/responses/ServerError'
|
|
283
|
-
/collections/{collectionId}/items/{featureId}/download:
|
|
284
|
-
get:
|
|
285
|
-
tags:
|
|
286
|
-
- Data
|
|
287
|
-
parameters:
|
|
288
|
-
- $ref: '#/components/parameters/provider'
|
|
289
|
-
- $ref: '#/components/parameters/collectionId'
|
|
290
|
-
- $ref: '#/components/parameters/featureId'
|
|
291
|
-
summary: download a single feature assets archive
|
|
292
|
-
description: |-
|
|
293
|
-
Download the feature with id `featureId` in the feature collection
|
|
294
|
-
with id `collectionId`.
|
|
295
|
-
operationId: downloadFeature
|
|
296
|
-
responses:
|
|
297
|
-
'200':
|
|
298
|
-
description: Successful `application/zip` response
|
|
299
|
-
content:
|
|
300
|
-
application/octet-stream:
|
|
301
|
-
schema:
|
|
302
|
-
type: string
|
|
303
|
-
format: binary
|
|
304
|
-
'404':
|
|
305
|
-
$ref: '#/components/responses/NotFound'
|
|
306
|
-
'500':
|
|
307
|
-
$ref: '#/components/responses/ServerError'
|
|
308
|
-
/search:
|
|
309
|
-
get:
|
|
310
|
-
summary: Search STAC items with simple filtering.
|
|
311
|
-
description: |-
|
|
312
|
-
Retrieve Items matching filters. Intended as a shorthand API for simple
|
|
313
|
-
queries.
|
|
314
|
-
operationId: getSearchSTAC
|
|
315
|
-
tags:
|
|
316
|
-
- STAC
|
|
317
|
-
parameters:
|
|
318
|
-
- $ref: '#/components/parameters/bbox'
|
|
319
|
-
- $ref: '#/components/parameters/datetime'
|
|
320
|
-
- $ref: '#/components/parameters/limit'
|
|
321
|
-
- $ref: '#/components/parameters/intersects'
|
|
322
|
-
- $ref: '#/components/parameters/ids'
|
|
323
|
-
- $ref: '#/components/parameters/collectionsArray'
|
|
324
|
-
- $ref: '#/components/parameters/provider'
|
|
325
|
-
- $ref: '#/components/parameters/filter'
|
|
326
|
-
- $ref: '#/components/parameters/sortby'
|
|
327
|
-
responses:
|
|
328
|
-
'200':
|
|
329
|
-
description: A feature collection.
|
|
330
|
-
content:
|
|
331
|
-
application/geo+json:
|
|
332
|
-
schema:
|
|
333
|
-
$ref: '#/components/schemas/itemCollection'
|
|
334
|
-
text/html:
|
|
335
|
-
schema:
|
|
336
|
-
type: string
|
|
337
|
-
default:
|
|
338
|
-
description: An error occurred.
|
|
339
|
-
content:
|
|
340
|
-
application/json:
|
|
341
|
-
schema:
|
|
342
|
-
$ref: '#/components/schemas/exception'
|
|
343
|
-
text/html:
|
|
344
|
-
schema:
|
|
345
|
-
type: string
|
|
346
|
-
post:
|
|
347
|
-
summary: Search STAC items with full-featured filtering.
|
|
348
|
-
description: |-
|
|
349
|
-
Retrieve items matching filters. Intended as the standard, full-featured
|
|
350
|
-
query API.
|
|
351
|
-
tags:
|
|
352
|
-
- STAC
|
|
353
|
-
operationId: postSearchSTAC
|
|
354
|
-
requestBody:
|
|
355
|
-
description: |
|
|
356
|
-
The `POST /search` JSON body specification is detailed in the
|
|
357
|
-
[STAC specification](https://api.stacspec.org/v1.0.0/item-search/).
|
|
358
|
-
Both [Query](https://github.com/stac-api-extensions/query) and
|
|
359
|
-
[Filter](https://github.com/stac-api-extensions/filter) extensions are supported.
|
|
360
|
-
required: true
|
|
361
|
-
content:
|
|
362
|
-
application/json:
|
|
363
|
-
schema:
|
|
364
|
-
allOf:
|
|
365
|
-
- $ref: '#/components/schemas/searchBody'
|
|
366
|
-
- $ref: 'https://api.stacspec.org/v1.0.0-beta.3/item-search/openapi.yaml#/components/schemas/components-schemas-searchBody'
|
|
367
|
-
responses:
|
|
368
|
-
'200':
|
|
369
|
-
description: A feature collection.
|
|
370
|
-
content:
|
|
371
|
-
application/geo+json:
|
|
372
|
-
schema:
|
|
373
|
-
$ref: '#/components/schemas/itemCollection'
|
|
374
|
-
text/html:
|
|
375
|
-
schema:
|
|
376
|
-
type: string
|
|
377
|
-
default:
|
|
378
|
-
description: An error occurred.
|
|
379
|
-
content:
|
|
380
|
-
application/json:
|
|
381
|
-
schema:
|
|
382
|
-
$ref: '#/components/schemas/exception'
|
|
383
|
-
text/html:
|
|
384
|
-
schema:
|
|
385
|
-
type: string
|
|
386
|
-
components:
|
|
387
|
-
parameters:
|
|
388
|
-
q:
|
|
389
|
-
name: q
|
|
390
|
-
in: query
|
|
391
|
-
description: |-
|
|
392
|
-
The optional q parameter supports keyword searching. Only records
|
|
393
|
-
whose text fields contain one or more of the specified search terms
|
|
394
|
-
are selected. The specific set of text keys/fields/properties of a
|
|
395
|
-
record to which the q operator is applied is up to the description
|
|
396
|
-
of the server. Implementations should, however, apply the q
|
|
397
|
-
operator to the title, description and keywords keys/fields/properties.
|
|
398
|
-
required: false
|
|
399
|
-
schema:
|
|
400
|
-
type: array
|
|
401
|
-
items:
|
|
402
|
-
type: string
|
|
403
|
-
style: form
|
|
404
|
-
explode: false
|
|
405
|
-
intersects:
|
|
406
|
-
name: intersects
|
|
407
|
-
in: query
|
|
408
|
-
description: Searches items by performing intersection between their geometry and provided GeoJSON geometry. All GeoJSON geometry types must be supported.
|
|
409
|
-
required: false
|
|
410
|
-
schema:
|
|
411
|
-
$ref: '#/components/schemas/geometryGeoJSON'
|
|
412
|
-
style: form
|
|
413
|
-
explode: false
|
|
414
|
-
bbox:
|
|
415
|
-
name: bbox
|
|
416
|
-
in: query
|
|
417
|
-
description: >-
|
|
418
|
-
Only features that have a geometry that intersects the bounding box are
|
|
419
|
-
selected.
|
|
420
|
-
|
|
421
|
-
The bounding box is provided as four or six numbers, depending on
|
|
422
|
-
|
|
423
|
-
whether the coordinate reference system includes a vertical axis (height
|
|
424
|
-
|
|
425
|
-
or depth):
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
* Lower left corner, coordinate axis 1
|
|
429
|
-
|
|
430
|
-
* Lower left corner, coordinate axis 2
|
|
431
|
-
|
|
432
|
-
* Minimum value, coordinate axis 3 (optional)
|
|
433
|
-
|
|
434
|
-
* Upper right corner, coordinate axis 1
|
|
435
|
-
|
|
436
|
-
* Upper right corner, coordinate axis 2
|
|
437
|
-
|
|
438
|
-
* Maximum value, coordinate axis 3 (optional)
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
The coordinate reference system of the values is WGS 84
|
|
442
|
-
|
|
443
|
-
longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84) unless
|
|
444
|
-
|
|
445
|
-
a different coordinate reference system is specified in the parameter
|
|
446
|
-
|
|
447
|
-
`bbox-crs`.
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
For WGS 84 longitude/latitude the values are in most cases the sequence
|
|
451
|
-
|
|
452
|
-
of minimum longitude, minimum latitude, maximum longitude and maximum
|
|
453
|
-
|
|
454
|
-
latitude. However, in cases where the box spans the antimeridian the
|
|
455
|
-
|
|
456
|
-
first value (west-most box edge) is larger than the third value
|
|
457
|
-
|
|
458
|
-
(east-most box edge).
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
If the vertical axis is included, the third and the sixth number are
|
|
462
|
-
|
|
463
|
-
the bottom and the top of the 3-dimensional bounding box.
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
If a feature has multiple spatial geometry properties, it is the
|
|
467
|
-
|
|
468
|
-
decision of the server whether only a single spatial geometry property
|
|
469
|
-
|
|
470
|
-
is used to determine the extent or all relevant geometries.
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
Example: The bounding box of the New Zealand Exclusive Economic Zone in
|
|
474
|
-
|
|
475
|
-
WGS 84 (from 160.6°E to 170°W and from 55.95°S to 25.89°S) would be
|
|
476
|
-
|
|
477
|
-
represented in JSON as `[160.6, -55.95, -170, -25.89]` and in a query as
|
|
478
|
-
|
|
479
|
-
`bbox=160.6,-55.95,-170,-25.89`.
|
|
480
|
-
required: false
|
|
481
|
-
schema:
|
|
482
|
-
type: array
|
|
483
|
-
minItems: 4
|
|
484
|
-
maxItems: 6
|
|
485
|
-
items:
|
|
486
|
-
type: number
|
|
487
|
-
style: form
|
|
488
|
-
explode: false
|
|
489
|
-
collectionId:
|
|
490
|
-
name: collectionId
|
|
491
|
-
in: path
|
|
492
|
-
description: local identifier of a collection (for example `S2_MSI_L1C`)
|
|
493
|
-
required: true
|
|
494
|
-
schema:
|
|
495
|
-
type: string
|
|
496
|
-
queryablesAdditionalParameters:
|
|
497
|
-
name: additional parameters
|
|
498
|
-
in: query
|
|
499
|
-
description: >-
|
|
500
|
-
Search parameters that will be used to filter remaining queryable parameters available value, if constraints
|
|
501
|
-
are set for the given collection.
|
|
502
|
-
Empty values can be associated to parameters in order to unset existing default values.
|
|
503
|
-
|
|
504
|
-
Examples:
|
|
505
|
-
|
|
506
|
-
* remove queryables defaults to view all available values `{"system_version": null, "model_levels: null}`
|
|
507
|
-
|
|
508
|
-
* add a search parameter to check associated available queryables values `{"variable": "elevation"}`
|
|
509
|
-
|
|
510
|
-
schema:
|
|
511
|
-
type: object
|
|
512
|
-
catalogPath:
|
|
513
|
-
name: catalogPath
|
|
514
|
-
in: path
|
|
515
|
-
required: true
|
|
516
|
-
description: |-
|
|
517
|
-
The catalog's path.
|
|
518
|
-
For a nested catalog, provide the root-related path to the catalog (for example `S2_MSI_L1C/year/2023`)
|
|
519
|
-
schema:
|
|
520
|
-
type: string
|
|
521
|
-
query:
|
|
522
|
-
name: query
|
|
523
|
-
x-stac-api-fragment: query
|
|
524
|
-
in: query
|
|
525
|
-
description: |-
|
|
526
|
-
**Extension:** Query
|
|
527
|
-
|
|
528
|
-
Query for properties in items.
|
|
529
|
-
Use the JSON form of the query used in POST.
|
|
530
|
-
required: false
|
|
531
|
-
schema:
|
|
532
|
-
type: string
|
|
533
|
-
datetime:
|
|
534
|
-
name: datetime
|
|
535
|
-
in: query
|
|
536
|
-
description: >-
|
|
537
|
-
Either a date-time or an interval, open or closed. Date and time
|
|
538
|
-
expressions
|
|
539
|
-
|
|
540
|
-
adhere to RFC 3339. Open intervals are expressed using double-dots.
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
Examples:
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
* A date-time: `2023-10-12T23:20:50Z`
|
|
547
|
-
|
|
548
|
-
* A closed interval: `2023-10-12T00:00:00Z/2023-11-10T12:31:12Z`
|
|
549
|
-
|
|
550
|
-
* Open intervals: `2023-10-12T00:00:00Z/..` or `../2023-11-10T12:31:12Z`
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
Only features that have a temporal property that intersects the value of
|
|
554
|
-
|
|
555
|
-
`datetime` are selected.
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
If a feature has multiple temporal properties, it is the decision of the
|
|
559
|
-
|
|
560
|
-
server whether only a single temporal property is used to determine
|
|
561
|
-
|
|
562
|
-
the extent or all relevant temporal properties.
|
|
563
|
-
required: false
|
|
564
|
-
schema:
|
|
565
|
-
type: string
|
|
566
|
-
style: form
|
|
567
|
-
explode: false
|
|
568
|
-
featureId:
|
|
569
|
-
name: featureId
|
|
570
|
-
in: path
|
|
571
|
-
description: local identifier of a feature (for example `S2B_MSIL1C_20231030T110109_N0509_R094_T31TCJ_20231030T115103`)
|
|
572
|
-
required: true
|
|
573
|
-
schema:
|
|
574
|
-
type: string
|
|
575
|
-
limit:
|
|
576
|
-
name: limit
|
|
577
|
-
in: query
|
|
578
|
-
description: >-
|
|
579
|
-
The optional limit parameter limits the number of items that are
|
|
580
|
-
presented in the response document.
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
Only items are counted that are on the first level of the collection in
|
|
584
|
-
the response document.
|
|
585
|
-
|
|
586
|
-
Nested objects contained within the explicitly requested items shall not
|
|
587
|
-
be counted.
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
Minimum = 1. Maximum = 10000. Default = 20.
|
|
591
|
-
required: false
|
|
592
|
-
schema:
|
|
593
|
-
type: integer
|
|
594
|
-
minimum: 1
|
|
595
|
-
maximum: 10000
|
|
596
|
-
style: form
|
|
597
|
-
explode: false
|
|
598
|
-
ids:
|
|
599
|
-
name: ids
|
|
600
|
-
in: query
|
|
601
|
-
description: |-
|
|
602
|
-
Array of Item ids to return (for example
|
|
603
|
-
`["S2B_MSIL1C_20231030T110109_N0509_R094_T31TCJ_20231030T115103",
|
|
604
|
-
"S2A_MSIL1C_20231029T104141_N0509_R008_T31TCJ_20231029T141106"]`).
|
|
605
|
-
|
|
606
|
-
**All other filter parameters that further restrict the number of search results are ignored.**
|
|
607
|
-
required: false
|
|
608
|
-
schema:
|
|
609
|
-
$ref: '#/components/schemas/ids'
|
|
610
|
-
explode: false
|
|
611
|
-
collectionsArray:
|
|
612
|
-
name: collections
|
|
613
|
-
in: query
|
|
614
|
-
description: |
|
|
615
|
-
Array of Collection IDs to include in the search for items.
|
|
616
|
-
Only Items in one of the provided Collections will be searched
|
|
617
|
-
required: true
|
|
618
|
-
schema:
|
|
619
|
-
$ref: '#/components/schemas/collectionsArray'
|
|
620
|
-
explode: false
|
|
621
|
-
provider:
|
|
622
|
-
name: provider
|
|
623
|
-
in: query
|
|
624
|
-
description: |
|
|
625
|
-
Provider from which the requested data shall be fetched;
|
|
626
|
-
If the requested data is available from this provider it will be used instead of the provider with the highest configured priority.
|
|
627
|
-
required: false
|
|
628
|
-
schema:
|
|
629
|
-
type: string
|
|
630
|
-
filter:
|
|
631
|
-
name: filter
|
|
632
|
-
x-stac-api-fragment: filter
|
|
633
|
-
in: query
|
|
634
|
-
description: |-
|
|
635
|
-
A CQL filter expression for filtering items.
|
|
636
|
-
required: false
|
|
637
|
-
schema:
|
|
638
|
-
oneOf:
|
|
639
|
-
- $ref: 'https://api.stacspec.org/v1.0.0-beta.3/item-search/openapi.yaml#/components/schemas/booleanValueExpression'
|
|
640
|
-
- $ref: '#/components/schemas/filter-cql-text'
|
|
641
|
-
sortby:
|
|
642
|
-
name: sortby
|
|
643
|
-
x-stac-api-fragment: sort
|
|
644
|
-
in: query
|
|
645
|
-
description: |-
|
|
646
|
-
An array of property names, prefixed by either "+" for ascending or
|
|
647
|
-
"-" for descending. If no prefix is provided, "+" is assumed.
|
|
648
|
-
required: false
|
|
649
|
-
schema:
|
|
650
|
-
type: string
|
|
651
|
-
example: '+start_datetime'
|
|
652
|
-
style: form
|
|
653
|
-
explode: false
|
|
654
|
-
schemas:
|
|
655
|
-
queryProp:
|
|
656
|
-
description: Apply query operations to a specific property
|
|
657
|
-
anyOf:
|
|
658
|
-
- description: if the object doesn't contain any of the operators, it is equivalent to using the equals operator
|
|
659
|
-
- type: object
|
|
660
|
-
description: Match using an operator
|
|
661
|
-
properties:
|
|
662
|
-
lte:
|
|
663
|
-
description: |-
|
|
664
|
-
Find items with a property value less than or equal the specified value.
|
|
665
|
-
In EODAG, only `eo:cloud_cover` supports this operator.
|
|
666
|
-
oneOf:
|
|
667
|
-
- type: number
|
|
668
|
-
eq:
|
|
669
|
-
description: |-
|
|
670
|
-
Find items with a property that is equal to the specified value.
|
|
671
|
-
For strings, a case-insensitive comparison must be performed.
|
|
672
|
-
In EODAG, this operator is implemented for all parameters but `eo:cloud_cover`
|
|
673
|
-
nullable: true
|
|
674
|
-
oneOf:
|
|
675
|
-
- type: string
|
|
676
|
-
- type: number
|
|
677
|
-
- type: boolean
|
|
678
|
-
query:
|
|
679
|
-
type: object
|
|
680
|
-
description: Define which parameters are queryable and the operators associated with each
|
|
681
|
-
additionalProperties:
|
|
682
|
-
$ref: '#/components/schemas/queryProp'
|
|
683
|
-
example:
|
|
684
|
-
platform:
|
|
685
|
-
eq: S2A
|
|
686
|
-
eo:cloud_cover:
|
|
687
|
-
lte: 80
|
|
688
|
-
collection:
|
|
689
|
-
type: object
|
|
690
|
-
required:
|
|
691
|
-
- id
|
|
692
|
-
- links
|
|
693
|
-
- stac_version
|
|
694
|
-
- description
|
|
695
|
-
- license
|
|
696
|
-
- extent
|
|
697
|
-
properties:
|
|
698
|
-
id:
|
|
699
|
-
description: 'identifier of the collection used, for example, in URIs'
|
|
700
|
-
type: string
|
|
701
|
-
example: address
|
|
702
|
-
title:
|
|
703
|
-
description: human readable title of the collection
|
|
704
|
-
type: string
|
|
705
|
-
example: address
|
|
706
|
-
description:
|
|
707
|
-
description: a description of the features in the collection
|
|
708
|
-
type: string
|
|
709
|
-
example: An address.
|
|
710
|
-
$ref: '#/components/schemas/description'
|
|
711
|
-
links:
|
|
712
|
-
type: array
|
|
713
|
-
items:
|
|
714
|
-
$ref: '#/components/schemas/link'
|
|
715
|
-
example:
|
|
716
|
-
- href: 'http://data.example.com/buildings'
|
|
717
|
-
rel: item
|
|
718
|
-
- href: 'http://example.com/concepts/buildings.html'
|
|
719
|
-
rel: describedBy
|
|
720
|
-
type: text/html
|
|
721
|
-
extent:
|
|
722
|
-
$ref: '#/components/schemas/extent'
|
|
723
|
-
itemType:
|
|
724
|
-
description: >-
|
|
725
|
-
indicator about the type of the items in the collection (the default
|
|
726
|
-
value is 'feature').
|
|
727
|
-
type: string
|
|
728
|
-
default: feature
|
|
729
|
-
crs:
|
|
730
|
-
description: the list of coordinate reference systems supported by the service
|
|
731
|
-
type: array
|
|
732
|
-
items:
|
|
733
|
-
type: string
|
|
734
|
-
default:
|
|
735
|
-
- 'http://www.opengis.net/def/crs/OGC/1.3/CRS84'
|
|
736
|
-
example:
|
|
737
|
-
- 'http://www.opengis.net/def/crs/OGC/1.3/CRS84'
|
|
738
|
-
- 'http://www.opengis.net/def/crs/EPSG/0/4326'
|
|
739
|
-
stac_version:
|
|
740
|
-
$ref: '#/components/schemas/stac_version'
|
|
741
|
-
stac_extensions:
|
|
742
|
-
$ref: '#/components/schemas/stac_extensions'
|
|
743
|
-
keywords:
|
|
744
|
-
type: array
|
|
745
|
-
description: List of keywords describing the collection.
|
|
746
|
-
items:
|
|
747
|
-
type: string
|
|
748
|
-
license:
|
|
749
|
-
$ref: '#/components/schemas/license'
|
|
750
|
-
providers:
|
|
751
|
-
$ref: '#/components/schemas/providers'
|
|
752
|
-
summaries:
|
|
753
|
-
description: |-
|
|
754
|
-
Summaries are either a unique set of all available values *or*
|
|
755
|
-
statistics. Statistics by default only specify the range (minimum
|
|
756
|
-
and maximum values), but can optionally be accompanied by additional
|
|
757
|
-
statistical values. The range can specify the potential range of
|
|
758
|
-
values, but it is recommended to be as precise as possible. The set
|
|
759
|
-
of values must contain at least one element and it is strongly
|
|
760
|
-
recommended to list all values. It is recommended to list as many
|
|
761
|
-
properties as reasonable so that consumers get a full overview of
|
|
762
|
-
the Collection. Properties that are covered by the Collection
|
|
763
|
-
specification (e.g. `providers` and `license`) may not be repeated
|
|
764
|
-
in the summaries.
|
|
765
|
-
type: object
|
|
766
|
-
additionalProperties:
|
|
767
|
-
oneOf:
|
|
768
|
-
- type: array
|
|
769
|
-
title: Set of values
|
|
770
|
-
items:
|
|
771
|
-
description: A value of any type.
|
|
772
|
-
- type: object
|
|
773
|
-
title: Statistics
|
|
774
|
-
description: |-
|
|
775
|
-
By default, only ranges with a minimum and a maximum value can
|
|
776
|
-
be specified. Ranges can be specified for ordinal values only,
|
|
777
|
-
which means they need to have a rank order. Therefore, ranges
|
|
778
|
-
can only be specified for numbers and some special types of
|
|
779
|
-
strings. Examples: grades (A to F), dates or times.
|
|
780
|
-
Implementors are free to add other derived statistical values
|
|
781
|
-
to the object, for example `mean` or `stddev`.
|
|
782
|
-
required:
|
|
783
|
-
- min
|
|
784
|
-
- max
|
|
785
|
-
properties:
|
|
786
|
-
min:
|
|
787
|
-
anyOf:
|
|
788
|
-
- type: string
|
|
789
|
-
- type: number
|
|
790
|
-
max:
|
|
791
|
-
anyOf:
|
|
792
|
-
- type: string
|
|
793
|
-
- type: number
|
|
794
|
-
example:
|
|
795
|
-
stac_version: 0.9.0
|
|
796
|
-
stac_extensions: []
|
|
797
|
-
id: Sentinel-2
|
|
798
|
-
title: 'Sentinel-2 MSI: MultiSpectral Instrument, Level-1C'
|
|
799
|
-
description: |
|
|
800
|
-
Sentinel-2 is a wide-swath, high-resolution, multi-spectral
|
|
801
|
-
imaging mission...
|
|
802
|
-
license: other
|
|
803
|
-
keywords:
|
|
804
|
-
- copernicus
|
|
805
|
-
- esa
|
|
806
|
-
- eu
|
|
807
|
-
- msi
|
|
808
|
-
- radiance
|
|
809
|
-
- sentinel
|
|
810
|
-
providers:
|
|
811
|
-
- name: ESA
|
|
812
|
-
roles:
|
|
813
|
-
- producer
|
|
814
|
-
- licensor
|
|
815
|
-
url: 'https://sentinel.esa.int/web/sentinel/user-guides/sentinel-2-msi'
|
|
816
|
-
extent:
|
|
817
|
-
spatial:
|
|
818
|
-
bbox:
|
|
819
|
-
- - -180
|
|
820
|
-
- -56
|
|
821
|
-
- 180
|
|
822
|
-
- 83
|
|
823
|
-
temporal:
|
|
824
|
-
interval:
|
|
825
|
-
- - '2015-06-23T00:00:00Z'
|
|
826
|
-
- '2019-07-10T13:44:56Z'
|
|
827
|
-
summaries:
|
|
828
|
-
datetime:
|
|
829
|
-
min: '2015-06-23T00:00:00Z'
|
|
830
|
-
max: '2019-07-10T13:44:56Z'
|
|
831
|
-
'sci:citation':
|
|
832
|
-
- 'Copernicus Sentinel data [Year]'
|
|
833
|
-
'eo:gsd':
|
|
834
|
-
- 10
|
|
835
|
-
- 30
|
|
836
|
-
- 60
|
|
837
|
-
platform:
|
|
838
|
-
- sentinel-2a
|
|
839
|
-
- sentinel-2b
|
|
840
|
-
constellation:
|
|
841
|
-
- sentinel-2
|
|
842
|
-
instruments:
|
|
843
|
-
- msi
|
|
844
|
-
'view:off_nadir':
|
|
845
|
-
min: 0
|
|
846
|
-
max: 100
|
|
847
|
-
'view:sun_elevation':
|
|
848
|
-
min: 6.78
|
|
849
|
-
max: 89.9
|
|
850
|
-
'eo:bands':
|
|
851
|
-
- - name: B1
|
|
852
|
-
common_name: coastal
|
|
853
|
-
center_wavelength: 4.439
|
|
854
|
-
- name: B2
|
|
855
|
-
common_name: blue
|
|
856
|
-
center_wavelength: 4.966
|
|
857
|
-
- name: B3
|
|
858
|
-
common_name: green
|
|
859
|
-
center_wavelength: 5.6
|
|
860
|
-
- name: B4
|
|
861
|
-
common_name: red
|
|
862
|
-
center_wavelength: 6.645
|
|
863
|
-
- name: B5
|
|
864
|
-
center_wavelength: 7.039
|
|
865
|
-
- name: B6
|
|
866
|
-
center_wavelength: 7.402
|
|
867
|
-
- name: B7
|
|
868
|
-
center_wavelength: 7.825
|
|
869
|
-
- name: B8
|
|
870
|
-
common_name: nir
|
|
871
|
-
center_wavelength: 8.351
|
|
872
|
-
- name: B8A
|
|
873
|
-
center_wavelength: 8.648
|
|
874
|
-
- name: B9
|
|
875
|
-
center_wavelength: 9.45
|
|
876
|
-
- name: B10
|
|
877
|
-
center_wavelength: 1.3735
|
|
878
|
-
- name: B11
|
|
879
|
-
common_name: swir16
|
|
880
|
-
center_wavelength: 1.6137
|
|
881
|
-
- name: B12
|
|
882
|
-
common_name: swir22
|
|
883
|
-
center_wavelength: 2.2024
|
|
884
|
-
links:
|
|
885
|
-
- rel: self
|
|
886
|
-
href: 'http://cool-sat.com/collections/Sentinel-2'
|
|
887
|
-
- rel: root
|
|
888
|
-
href: 'http://cool-sat.com/collections'
|
|
889
|
-
- rel: license
|
|
890
|
-
href: >-
|
|
891
|
-
https://scihub.copernicus.eu/twiki/pub/SciHubWebPortal/TermsConditions/Sentinel_Data_Terms_and_Conditions.pdf
|
|
892
|
-
title: >-
|
|
893
|
-
Legal notice on the use of Copernicus Sentinel Data and Service
|
|
894
|
-
Information
|
|
895
|
-
collections:
|
|
896
|
-
type: object
|
|
897
|
-
required:
|
|
898
|
-
- links
|
|
899
|
-
- collections
|
|
900
|
-
properties:
|
|
901
|
-
links:
|
|
902
|
-
type: array
|
|
903
|
-
items:
|
|
904
|
-
$ref: '#/components/schemas/link'
|
|
905
|
-
collections:
|
|
906
|
-
type: array
|
|
907
|
-
items:
|
|
908
|
-
$ref: '#/components/schemas/collection'
|
|
909
|
-
confClasses:
|
|
910
|
-
type: object
|
|
911
|
-
required:
|
|
912
|
-
- conformsTo
|
|
913
|
-
properties:
|
|
914
|
-
conformsTo:
|
|
915
|
-
type: array
|
|
916
|
-
items:
|
|
917
|
-
type: string
|
|
918
|
-
exception:
|
|
919
|
-
type: object
|
|
920
|
-
description: >-
|
|
921
|
-
Information about the exception: an error code plus an optional
|
|
922
|
-
description.
|
|
923
|
-
required:
|
|
924
|
-
- code
|
|
925
|
-
properties:
|
|
926
|
-
description:
|
|
927
|
-
type: string
|
|
928
|
-
extent:
|
|
929
|
-
type: object
|
|
930
|
-
description: >-
|
|
931
|
-
The extent of the features in the collection. In the Core only spatial
|
|
932
|
-
and temporal
|
|
933
|
-
|
|
934
|
-
extents are specified. Extensions may add additional members to
|
|
935
|
-
represent other
|
|
936
|
-
|
|
937
|
-
extents, for example, thermal or pressure ranges.
|
|
938
|
-
properties:
|
|
939
|
-
spatial:
|
|
940
|
-
description: The spatial extent of the features in the collection.
|
|
941
|
-
type: object
|
|
942
|
-
properties:
|
|
943
|
-
bbox:
|
|
944
|
-
description: >-
|
|
945
|
-
One or more bounding boxes that describe the spatial extent of
|
|
946
|
-
the dataset.
|
|
947
|
-
|
|
948
|
-
In the Core only a single bounding box is supported. Extensions
|
|
949
|
-
may support
|
|
950
|
-
|
|
951
|
-
additional areas. If multiple areas are provided, the union of
|
|
952
|
-
the bounding
|
|
953
|
-
|
|
954
|
-
boxes describes the spatial extent.
|
|
955
|
-
type: array
|
|
956
|
-
minItems: 1
|
|
957
|
-
items:
|
|
958
|
-
description: >-
|
|
959
|
-
Each bounding box is provided as four or six numbers,
|
|
960
|
-
depending on
|
|
961
|
-
|
|
962
|
-
whether the coordinate reference system includes a vertical
|
|
963
|
-
axis
|
|
964
|
-
|
|
965
|
-
(height or depth):
|
|
966
|
-
|
|
967
|
-
|
|
968
|
-
* Lower left corner, coordinate axis 1
|
|
969
|
-
|
|
970
|
-
* Lower left corner, coordinate axis 2
|
|
971
|
-
|
|
972
|
-
* Minimum value, coordinate axis 3 (optional)
|
|
973
|
-
|
|
974
|
-
* Upper right corner, coordinate axis 1
|
|
975
|
-
|
|
976
|
-
* Upper right corner, coordinate axis 2
|
|
977
|
-
|
|
978
|
-
* Maximum value, coordinate axis 3 (optional)
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
The coordinate reference system of the values is WGS 84
|
|
982
|
-
longitude/latitude
|
|
983
|
-
|
|
984
|
-
(http://www.opengis.net/def/crs/OGC/1.3/CRS84) unless a
|
|
985
|
-
different coordinate
|
|
986
|
-
|
|
987
|
-
reference system is specified in `crs`.
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
For WGS 84 longitude/latitude the values are in most cases the
|
|
991
|
-
sequence of
|
|
992
|
-
|
|
993
|
-
minimum longitude, minimum latitude, maximum longitude and
|
|
994
|
-
maximum latitude.
|
|
995
|
-
|
|
996
|
-
However, in cases where the box spans the antimeridian the
|
|
997
|
-
first value
|
|
998
|
-
|
|
999
|
-
(west-most box edge) is larger than the third value (east-most
|
|
1000
|
-
box edge).
|
|
1001
|
-
|
|
1002
|
-
|
|
1003
|
-
If the vertical axis is included, the third and the sixth
|
|
1004
|
-
number are
|
|
1005
|
-
|
|
1006
|
-
the bottom and the top of the 3-dimensional bounding box.
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
If a feature has multiple spatial geometry properties, it is
|
|
1010
|
-
the decision of the
|
|
1011
|
-
|
|
1012
|
-
server whether only a single spatial geometry property is used
|
|
1013
|
-
to determine
|
|
1014
|
-
|
|
1015
|
-
the extent or all relevant geometries.
|
|
1016
|
-
type: array
|
|
1017
|
-
minItems: 4
|
|
1018
|
-
maxItems: 6
|
|
1019
|
-
items:
|
|
1020
|
-
type: number
|
|
1021
|
-
example:
|
|
1022
|
-
- -180
|
|
1023
|
-
- -90
|
|
1024
|
-
- 180
|
|
1025
|
-
- 90
|
|
1026
|
-
crs:
|
|
1027
|
-
description: >-
|
|
1028
|
-
Coordinate reference system of the coordinates in the spatial
|
|
1029
|
-
extent
|
|
1030
|
-
|
|
1031
|
-
(property `bbox`). The default reference system is WGS 84
|
|
1032
|
-
longitude/latitude.
|
|
1033
|
-
|
|
1034
|
-
In the Core this is the only supported coordinate reference
|
|
1035
|
-
system.
|
|
1036
|
-
|
|
1037
|
-
Extensions may support additional coordinate reference systems
|
|
1038
|
-
and add
|
|
1039
|
-
|
|
1040
|
-
additional enum values.
|
|
1041
|
-
type: string
|
|
1042
|
-
enum:
|
|
1043
|
-
- 'http://www.opengis.net/def/crs/OGC/1.3/CRS84'
|
|
1044
|
-
default: 'http://www.opengis.net/def/crs/OGC/1.3/CRS84'
|
|
1045
|
-
required:
|
|
1046
|
-
- bbox
|
|
1047
|
-
temporal:
|
|
1048
|
-
description: The temporal extent of the features in the collection.
|
|
1049
|
-
type: object
|
|
1050
|
-
properties:
|
|
1051
|
-
interval:
|
|
1052
|
-
description: >-
|
|
1053
|
-
One or more time intervals that describe the temporal extent of
|
|
1054
|
-
the dataset.
|
|
1055
|
-
|
|
1056
|
-
The value `null` is supported and indicates an open time
|
|
1057
|
-
intervall.
|
|
1058
|
-
|
|
1059
|
-
In the Core only a single time interval is supported. Extensions
|
|
1060
|
-
may support
|
|
1061
|
-
|
|
1062
|
-
multiple intervals. If multiple intervals are provided, the
|
|
1063
|
-
union of the
|
|
1064
|
-
|
|
1065
|
-
intervals describes the temporal extent.
|
|
1066
|
-
type: array
|
|
1067
|
-
minItems: 1
|
|
1068
|
-
items:
|
|
1069
|
-
description: >-
|
|
1070
|
-
Begin and end times of the time interval. The timestamps
|
|
1071
|
-
|
|
1072
|
-
are in the coordinate reference system specified in `trs`. By
|
|
1073
|
-
default
|
|
1074
|
-
|
|
1075
|
-
this is the Gregorian calendar.
|
|
1076
|
-
type: array
|
|
1077
|
-
minItems: 2
|
|
1078
|
-
maxItems: 2
|
|
1079
|
-
items:
|
|
1080
|
-
type: string
|
|
1081
|
-
format: date-time
|
|
1082
|
-
nullable: true
|
|
1083
|
-
example:
|
|
1084
|
-
- '2011-11-11T12:22:11Z'
|
|
1085
|
-
- null
|
|
1086
|
-
trs:
|
|
1087
|
-
description: >-
|
|
1088
|
-
Coordinate reference system of the coordinates in the temporal
|
|
1089
|
-
extent
|
|
1090
|
-
|
|
1091
|
-
(property `interval`). The default reference system is the
|
|
1092
|
-
Gregorian calendar.
|
|
1093
|
-
|
|
1094
|
-
In the Core this is the only supported temporal reference
|
|
1095
|
-
system.
|
|
1096
|
-
|
|
1097
|
-
Extensions may support additional temporal reference systems and
|
|
1098
|
-
add
|
|
1099
|
-
|
|
1100
|
-
additional enum values.
|
|
1101
|
-
type: string
|
|
1102
|
-
enum:
|
|
1103
|
-
- 'http://www.opengis.net/def/uom/ISO-8601/0/Gregorian'
|
|
1104
|
-
default: 'http://www.opengis.net/def/uom/ISO-8601/0/Gregorian'
|
|
1105
|
-
required:
|
|
1106
|
-
- interval
|
|
1107
|
-
required:
|
|
1108
|
-
- spatial
|
|
1109
|
-
- temporal
|
|
1110
|
-
featureCollectionGeoJSON:
|
|
1111
|
-
type: object
|
|
1112
|
-
required:
|
|
1113
|
-
- type
|
|
1114
|
-
- features
|
|
1115
|
-
properties:
|
|
1116
|
-
type:
|
|
1117
|
-
type: string
|
|
1118
|
-
enum:
|
|
1119
|
-
- FeatureCollection
|
|
1120
|
-
features:
|
|
1121
|
-
type: array
|
|
1122
|
-
items:
|
|
1123
|
-
$ref: '#/components/schemas/item'
|
|
1124
|
-
links:
|
|
1125
|
-
type: array
|
|
1126
|
-
items:
|
|
1127
|
-
$ref: '#/components/schemas/link'
|
|
1128
|
-
timeStamp:
|
|
1129
|
-
$ref: '#/components/schemas/timeStamp'
|
|
1130
|
-
numberMatched:
|
|
1131
|
-
$ref: '#/components/schemas/numberMatched'
|
|
1132
|
-
numberReturned:
|
|
1133
|
-
$ref: '#/components/schemas/numberReturned'
|
|
1134
|
-
featureGeoJSON:
|
|
1135
|
-
type: object
|
|
1136
|
-
required:
|
|
1137
|
-
- type
|
|
1138
|
-
- geometry
|
|
1139
|
-
- properties
|
|
1140
|
-
properties:
|
|
1141
|
-
type:
|
|
1142
|
-
type: string
|
|
1143
|
-
enum:
|
|
1144
|
-
- Feature
|
|
1145
|
-
geometry:
|
|
1146
|
-
$ref: '#/components/schemas/geometryGeoJSON'
|
|
1147
|
-
properties:
|
|
1148
|
-
type: object
|
|
1149
|
-
nullable: true
|
|
1150
|
-
id:
|
|
1151
|
-
oneOf:
|
|
1152
|
-
- type: string
|
|
1153
|
-
- type: integer
|
|
1154
|
-
links:
|
|
1155
|
-
type: array
|
|
1156
|
-
items:
|
|
1157
|
-
$ref: '#/components/schemas/link'
|
|
1158
|
-
filter-cql-text:
|
|
1159
|
-
description: |
|
|
1160
|
-
A CQL filter expression in the 'cql-text' encoding.
|
|
1161
|
-
type: string
|
|
1162
|
-
geometryGeoJSON:
|
|
1163
|
-
oneOf:
|
|
1164
|
-
- $ref: '#/components/schemas/pointGeoJSON'
|
|
1165
|
-
- $ref: '#/components/schemas/multipointGeoJSON'
|
|
1166
|
-
- $ref: '#/components/schemas/linestringGeoJSON'
|
|
1167
|
-
- $ref: '#/components/schemas/multilinestringGeoJSON'
|
|
1168
|
-
- $ref: '#/components/schemas/polygonGeoJSON'
|
|
1169
|
-
- $ref: '#/components/schemas/multipolygonGeoJSON'
|
|
1170
|
-
- $ref: '#/components/schemas/geometrycollectionGeoJSON'
|
|
1171
|
-
geometrycollectionGeoJSON:
|
|
1172
|
-
type: object
|
|
1173
|
-
required:
|
|
1174
|
-
- type
|
|
1175
|
-
- geometries
|
|
1176
|
-
properties:
|
|
1177
|
-
type:
|
|
1178
|
-
type: string
|
|
1179
|
-
enum:
|
|
1180
|
-
- GeometryCollection
|
|
1181
|
-
geometries:
|
|
1182
|
-
type: array
|
|
1183
|
-
items:
|
|
1184
|
-
$ref: '#/components/schemas/geometryGeoJSON'
|
|
1185
|
-
landingPage:
|
|
1186
|
-
type: object
|
|
1187
|
-
required:
|
|
1188
|
-
- links
|
|
1189
|
-
- stac_version
|
|
1190
|
-
- id
|
|
1191
|
-
- description
|
|
1192
|
-
properties:
|
|
1193
|
-
title:
|
|
1194
|
-
type: string
|
|
1195
|
-
example: Buildings in Bonn
|
|
1196
|
-
description:
|
|
1197
|
-
type: string
|
|
1198
|
-
example: >-
|
|
1199
|
-
Access to data about buildings in the city of Bonn via a Web API
|
|
1200
|
-
that conforms to the OGC API Features specification.
|
|
1201
|
-
links:
|
|
1202
|
-
type: array
|
|
1203
|
-
items:
|
|
1204
|
-
$ref: '#/components/schemas/link'
|
|
1205
|
-
stac_version:
|
|
1206
|
-
$ref: '#/components/schemas/stac_version'
|
|
1207
|
-
stac_extensions:
|
|
1208
|
-
$ref: '#/components/schemas/stac_extensions'
|
|
1209
|
-
id:
|
|
1210
|
-
type: string
|
|
1211
|
-
linestringGeoJSON:
|
|
1212
|
-
type: object
|
|
1213
|
-
required:
|
|
1214
|
-
- type
|
|
1215
|
-
- coordinates
|
|
1216
|
-
properties:
|
|
1217
|
-
type:
|
|
1218
|
-
type: string
|
|
1219
|
-
enum:
|
|
1220
|
-
- LineString
|
|
1221
|
-
coordinates:
|
|
1222
|
-
type: array
|
|
1223
|
-
minItems: 2
|
|
1224
|
-
items:
|
|
1225
|
-
type: array
|
|
1226
|
-
minItems: 2
|
|
1227
|
-
items:
|
|
1228
|
-
type: number
|
|
1229
|
-
link:
|
|
1230
|
-
type: object
|
|
1231
|
-
required:
|
|
1232
|
-
- href
|
|
1233
|
-
- rel
|
|
1234
|
-
properties:
|
|
1235
|
-
href:
|
|
1236
|
-
type: string
|
|
1237
|
-
example: 'http://www.geoserver.example/stac/naip/child/catalog.json'
|
|
1238
|
-
format: url
|
|
1239
|
-
rel:
|
|
1240
|
-
type: string
|
|
1241
|
-
example: child
|
|
1242
|
-
type:
|
|
1243
|
-
type: string
|
|
1244
|
-
example: application/geo+json
|
|
1245
|
-
hreflang:
|
|
1246
|
-
type: string
|
|
1247
|
-
example: en
|
|
1248
|
-
title:
|
|
1249
|
-
type: string
|
|
1250
|
-
example: NAIP Child Catalog
|
|
1251
|
-
length:
|
|
1252
|
-
type: integer
|
|
1253
|
-
method:
|
|
1254
|
-
type: string
|
|
1255
|
-
enum:
|
|
1256
|
-
- GET
|
|
1257
|
-
- POST
|
|
1258
|
-
default: GET
|
|
1259
|
-
description: Specifies the HTTP method that the link expects
|
|
1260
|
-
headers:
|
|
1261
|
-
type: object
|
|
1262
|
-
description: Object key values pairs they map to headers
|
|
1263
|
-
example:
|
|
1264
|
-
Accept: application/json
|
|
1265
|
-
body:
|
|
1266
|
-
type: object
|
|
1267
|
-
description: >-
|
|
1268
|
-
For POST requests, the link can specify the HTTP body as a JSON
|
|
1269
|
-
object.
|
|
1270
|
-
merge:
|
|
1271
|
-
type: boolean
|
|
1272
|
-
default: false
|
|
1273
|
-
description: |-
|
|
1274
|
-
This is only valid when the server is responding to POST request.
|
|
1275
|
-
|
|
1276
|
-
If merge is true, the client is expected to merge the body value
|
|
1277
|
-
into the current request body before following the link.
|
|
1278
|
-
This avoids passing large post bodies back and forth when following
|
|
1279
|
-
links, particularly for navigating pages through the `POST /search`
|
|
1280
|
-
endpoint.
|
|
1281
|
-
|
|
1282
|
-
NOTE: To support form encoding it is expected that a client be able
|
|
1283
|
-
to merge in the key value pairs specified as JSON
|
|
1284
|
-
`{"next": "token"}` will become `&next=token`.
|
|
1285
|
-
title: Link
|
|
1286
|
-
multilinestringGeoJSON:
|
|
1287
|
-
type: object
|
|
1288
|
-
required:
|
|
1289
|
-
- type
|
|
1290
|
-
- coordinates
|
|
1291
|
-
properties:
|
|
1292
|
-
type:
|
|
1293
|
-
type: string
|
|
1294
|
-
enum:
|
|
1295
|
-
- MultiLineString
|
|
1296
|
-
coordinates:
|
|
1297
|
-
type: array
|
|
1298
|
-
items:
|
|
1299
|
-
type: array
|
|
1300
|
-
minItems: 2
|
|
1301
|
-
items:
|
|
1302
|
-
type: array
|
|
1303
|
-
minItems: 2
|
|
1304
|
-
items:
|
|
1305
|
-
type: number
|
|
1306
|
-
multipointGeoJSON:
|
|
1307
|
-
type: object
|
|
1308
|
-
required:
|
|
1309
|
-
- type
|
|
1310
|
-
- coordinates
|
|
1311
|
-
properties:
|
|
1312
|
-
type:
|
|
1313
|
-
type: string
|
|
1314
|
-
enum:
|
|
1315
|
-
- MultiPoint
|
|
1316
|
-
coordinates:
|
|
1317
|
-
type: array
|
|
1318
|
-
items:
|
|
1319
|
-
type: array
|
|
1320
|
-
minItems: 2
|
|
1321
|
-
items:
|
|
1322
|
-
type: number
|
|
1323
|
-
multipolygonGeoJSON:
|
|
1324
|
-
type: object
|
|
1325
|
-
required:
|
|
1326
|
-
- type
|
|
1327
|
-
- coordinates
|
|
1328
|
-
properties:
|
|
1329
|
-
type:
|
|
1330
|
-
type: string
|
|
1331
|
-
enum:
|
|
1332
|
-
- MultiPolygon
|
|
1333
|
-
coordinates:
|
|
1334
|
-
type: array
|
|
1335
|
-
items:
|
|
1336
|
-
type: array
|
|
1337
|
-
items:
|
|
1338
|
-
type: array
|
|
1339
|
-
minItems: 4
|
|
1340
|
-
items:
|
|
1341
|
-
type: array
|
|
1342
|
-
minItems: 2
|
|
1343
|
-
items:
|
|
1344
|
-
type: number
|
|
1345
|
-
numberMatched:
|
|
1346
|
-
description: |-
|
|
1347
|
-
The number of features of the feature type that match the selection
|
|
1348
|
-
parameters like `bbox`.
|
|
1349
|
-
type: integer
|
|
1350
|
-
minimum: 0
|
|
1351
|
-
example: 127
|
|
1352
|
-
numberReturned:
|
|
1353
|
-
description: |-
|
|
1354
|
-
The number of features in the feature collection.
|
|
1355
|
-
|
|
1356
|
-
A server may omit this information in a response, if the information
|
|
1357
|
-
about the number of features is not known or difficult to compute.
|
|
1358
|
-
|
|
1359
|
-
If the value is provided, the value shall be identical to the number
|
|
1360
|
-
of items in the "features" array.
|
|
1361
|
-
type: integer
|
|
1362
|
-
minimum: 0
|
|
1363
|
-
example: 10
|
|
1364
|
-
pointGeoJSON:
|
|
1365
|
-
type: object
|
|
1366
|
-
required:
|
|
1367
|
-
- type
|
|
1368
|
-
- coordinates
|
|
1369
|
-
properties:
|
|
1370
|
-
type:
|
|
1371
|
-
type: string
|
|
1372
|
-
enum:
|
|
1373
|
-
- Point
|
|
1374
|
-
coordinates:
|
|
1375
|
-
type: array
|
|
1376
|
-
minItems: 2
|
|
1377
|
-
items:
|
|
1378
|
-
type: number
|
|
1379
|
-
polygonGeoJSON:
|
|
1380
|
-
type: object
|
|
1381
|
-
required:
|
|
1382
|
-
- type
|
|
1383
|
-
- coordinates
|
|
1384
|
-
properties:
|
|
1385
|
-
type:
|
|
1386
|
-
type: string
|
|
1387
|
-
enum:
|
|
1388
|
-
- Polygon
|
|
1389
|
-
coordinates:
|
|
1390
|
-
type: array
|
|
1391
|
-
items:
|
|
1392
|
-
type: array
|
|
1393
|
-
minItems: 4
|
|
1394
|
-
items:
|
|
1395
|
-
type: array
|
|
1396
|
-
minItems: 2
|
|
1397
|
-
items:
|
|
1398
|
-
type: number
|
|
1399
|
-
timeStamp:
|
|
1400
|
-
description: >-
|
|
1401
|
-
This property indicates the time and date when the response was
|
|
1402
|
-
generated.
|
|
1403
|
-
type: string
|
|
1404
|
-
format: date-time
|
|
1405
|
-
example: '2017-08-17T08:05:32Z'
|
|
1406
|
-
description:
|
|
1407
|
-
type: string
|
|
1408
|
-
description: |-
|
|
1409
|
-
Detailed multi-line description to fully explain the catalog or
|
|
1410
|
-
collection.
|
|
1411
|
-
|
|
1412
|
-
[CommonMark 0.29](http://commonmark.org/) syntax MAY be used for rich
|
|
1413
|
-
text representation.
|
|
1414
|
-
license:
|
|
1415
|
-
type: string
|
|
1416
|
-
description: |-
|
|
1417
|
-
License(s) of the data as a SPDX
|
|
1418
|
-
[License identifier](https://spdx.org/licenses/). Alternatively, use
|
|
1419
|
-
`other` if the license is not on the SPDX license list or
|
|
1420
|
-
`various` if multiple licenses apply. In these two cases links to the
|
|
1421
|
-
license texts SHOULD be added, see the `license` link relation type.
|
|
1422
|
-
|
|
1423
|
-
Non-SPDX licenses SHOULD add a link to the license text with the
|
|
1424
|
-
`license` relation in the links section. The license text MUST NOT be
|
|
1425
|
-
provided as a value of this field. If there is no public license URL
|
|
1426
|
-
available, it is RECOMMENDED to host the license text and
|
|
1427
|
-
link to it.
|
|
1428
|
-
example: Apache-2.0
|
|
1429
|
-
providers:
|
|
1430
|
-
type: array
|
|
1431
|
-
description: >-
|
|
1432
|
-
A list of providers, which may include all organizations capturing or
|
|
1433
|
-
processing the data or the hosting provider. Providers should be listed
|
|
1434
|
-
in chronological order with the most recent provider being the last
|
|
1435
|
-
element of the list.
|
|
1436
|
-
items:
|
|
1437
|
-
type: object
|
|
1438
|
-
title: Provider
|
|
1439
|
-
required:
|
|
1440
|
-
- name
|
|
1441
|
-
properties:
|
|
1442
|
-
name:
|
|
1443
|
-
description: The name of the organization or the individual.
|
|
1444
|
-
type: string
|
|
1445
|
-
description:
|
|
1446
|
-
description: >-
|
|
1447
|
-
Multi-line description to add further provider information such as
|
|
1448
|
-
processing details for processors and producers, hosting details
|
|
1449
|
-
for hosts or basic contact information.
|
|
1450
|
-
|
|
1451
|
-
|
|
1452
|
-
CommonMark 0.29 syntax MAY be used for rich text representation.
|
|
1453
|
-
type: string
|
|
1454
|
-
roles:
|
|
1455
|
-
description: |-
|
|
1456
|
-
Roles of the provider.
|
|
1457
|
-
|
|
1458
|
-
The provider's role(s) can be one or more of the following
|
|
1459
|
-
elements:
|
|
1460
|
-
|
|
1461
|
-
* licensor: The organization that is licensing the dataset under
|
|
1462
|
-
the license specified in the collection's license field.
|
|
1463
|
-
* producer: The producer of the data is the provider that
|
|
1464
|
-
initially captured and processed the source data, e.g. ESA for
|
|
1465
|
-
Sentinel-2 data.
|
|
1466
|
-
* processor: A processor is any provider who processed data to a
|
|
1467
|
-
derived product.
|
|
1468
|
-
* host: The host is the actual provider offering the data on their
|
|
1469
|
-
storage. There should be no more than one host, specified as last
|
|
1470
|
-
element of the list.
|
|
1471
|
-
type: array
|
|
1472
|
-
items:
|
|
1473
|
-
type: string
|
|
1474
|
-
enum:
|
|
1475
|
-
- producer
|
|
1476
|
-
- licensor
|
|
1477
|
-
- processor
|
|
1478
|
-
- host
|
|
1479
|
-
url:
|
|
1480
|
-
description: >-
|
|
1481
|
-
Homepage on which the provider describes the dataset and publishes
|
|
1482
|
-
contact information.
|
|
1483
|
-
type: string
|
|
1484
|
-
format: url
|
|
1485
|
-
searchBody:
|
|
1486
|
-
required:
|
|
1487
|
-
- collections
|
|
1488
|
-
description: The search criteria
|
|
1489
|
-
type: object
|
|
1490
|
-
allOf:
|
|
1491
|
-
- $ref: '#/components/schemas/providerFilter'
|
|
1492
|
-
- $ref: '#/components/schemas/collectionsFilter'
|
|
1493
|
-
- $ref: '#/components/schemas/bboxFilter'
|
|
1494
|
-
- $ref: '#/components/schemas/datetimeFilter'
|
|
1495
|
-
- $ref: '#/components/schemas/intersectsFilter'
|
|
1496
|
-
- $ref: '#/components/schemas/idsFilter'
|
|
1497
|
-
- $ref: '#/components/schemas/limitFilter'
|
|
1498
|
-
- $ref: '#/components/schemas/queryFilter'
|
|
1499
|
-
example:
|
|
1500
|
-
datetime: 2023-11-03T00:00:00Z/2023-11-04T12:31:12Z
|
|
1501
|
-
bbox:
|
|
1502
|
-
- -12
|
|
1503
|
-
- 33
|
|
1504
|
-
- -11
|
|
1505
|
-
- 34
|
|
1506
|
-
collections:
|
|
1507
|
-
- S2_MSI_L1C
|
|
1508
|
-
query:
|
|
1509
|
-
platform:
|
|
1510
|
-
eq: S2A
|
|
1511
|
-
eo:cloud_cover:
|
|
1512
|
-
lte: 80
|
|
1513
|
-
provider: peps
|
|
1514
|
-
limit: 10
|
|
1515
|
-
limit:
|
|
1516
|
-
type: integer
|
|
1517
|
-
minimum: 1
|
|
1518
|
-
example: 10
|
|
1519
|
-
maximum: 10000
|
|
1520
|
-
description: The maximum number of results to return (page size). Defaults to 10
|
|
1521
|
-
bbox:
|
|
1522
|
-
description: |-
|
|
1523
|
-
Only features that have a geometry that intersects the bounding box are
|
|
1524
|
-
selected. The bounding box is provided as four or six numbers,
|
|
1525
|
-
depending on whether the coordinate reference system includes a
|
|
1526
|
-
vertical axis (elevation or depth):
|
|
1527
|
-
|
|
1528
|
-
* Lower left corner, coordinate axis 1
|
|
1529
|
-
* Lower left corner, coordinate axis 2
|
|
1530
|
-
* Lower left corner, coordinate axis 3 (optional)
|
|
1531
|
-
* Upper right corner, coordinate axis 1
|
|
1532
|
-
* Upper right corner, coordinate axis 2
|
|
1533
|
-
* Upper right corner, coordinate axis 3 (optional)
|
|
1534
|
-
|
|
1535
|
-
The coordinate reference system of the values is WGS84
|
|
1536
|
-
longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84) unless
|
|
1537
|
-
a different coordinate reference system is specified in the parameter
|
|
1538
|
-
`bbox-crs`.
|
|
1539
|
-
|
|
1540
|
-
For WGS84 longitude/latitude the values are in most cases the sequence
|
|
1541
|
-
of minimum longitude, minimum latitude, maximum longitude and maximum
|
|
1542
|
-
latitude. However, in cases where the box spans the antimeridian the
|
|
1543
|
-
first value (west-most box edge) is larger than the third value
|
|
1544
|
-
(east-most box edge).
|
|
1545
|
-
|
|
1546
|
-
If a feature has multiple spatial geometry properties, it is the
|
|
1547
|
-
decision of the server whether only a single spatial geometry property
|
|
1548
|
-
is used to determine the extent or all relevant geometries.
|
|
1549
|
-
|
|
1550
|
-
Example: The bounding box of the New Zealand Exclusive Economic Zone in
|
|
1551
|
-
WGS 84 (from 160.6°E to 170°W and from 55.95°S to 25.89°S) would be
|
|
1552
|
-
represented in JSON as `[160.6, -55.95, -170, -25.89]` and in a query as
|
|
1553
|
-
`bbox=160.6,-55.95,-170,-25.89`.
|
|
1554
|
-
type: array
|
|
1555
|
-
minItems: 4
|
|
1556
|
-
maxItems: 6
|
|
1557
|
-
items:
|
|
1558
|
-
type: number
|
|
1559
|
-
example:
|
|
1560
|
-
- -12
|
|
1561
|
-
- 33
|
|
1562
|
-
- -11
|
|
1563
|
-
- 34
|
|
1564
|
-
bboxFilter:
|
|
1565
|
-
type: object
|
|
1566
|
-
description: Only return items that intersect the provided bounding box.
|
|
1567
|
-
properties:
|
|
1568
|
-
bbox:
|
|
1569
|
-
$ref: '#/components/schemas/bbox'
|
|
1570
|
-
collectionsArray:
|
|
1571
|
-
type: array
|
|
1572
|
-
description: |-
|
|
1573
|
-
Array of Collection IDs to include in the search for items.
|
|
1574
|
-
Only Items in one of the provided Collections will be searched.
|
|
1575
|
-
items:
|
|
1576
|
-
type: string
|
|
1577
|
-
example:
|
|
1578
|
-
- S2_MSI_L1C
|
|
1579
|
-
ids:
|
|
1580
|
-
type: array
|
|
1581
|
-
description: |-
|
|
1582
|
-
Array of Item ids to return (for example
|
|
1583
|
-
`["S2B_MSIL1C_20231030T110109_N0509_R094_T31TCJ_20231030T115103",
|
|
1584
|
-
"S2A_MSIL1C_20231029T104141_N0509_R008_T31TCJ_20231029T141106"]`). All other filter parameters that further
|
|
1585
|
-
restrict the number of search results are ignored.
|
|
1586
|
-
items:
|
|
1587
|
-
type: string
|
|
1588
|
-
datetimeFilter:
|
|
1589
|
-
description: An object representing a date+time based filter.
|
|
1590
|
-
type: object
|
|
1591
|
-
properties:
|
|
1592
|
-
datetime:
|
|
1593
|
-
$ref: '#/components/schemas/datetime'
|
|
1594
|
-
intersectsFilter:
|
|
1595
|
-
type: object
|
|
1596
|
-
description: Only returns items that intersect with the provided polygon.
|
|
1597
|
-
properties:
|
|
1598
|
-
intersects:
|
|
1599
|
-
$ref: 'https://geojson.org/schema/Geometry.json'
|
|
1600
|
-
limitFilter:
|
|
1601
|
-
type: object
|
|
1602
|
-
description: Only returns maximum number of results (page size)
|
|
1603
|
-
properties:
|
|
1604
|
-
limit:
|
|
1605
|
-
$ref: '#/components/schemas/limit'
|
|
1606
|
-
idsFilter:
|
|
1607
|
-
type: object
|
|
1608
|
-
description: Only returns items that match the array of given ids
|
|
1609
|
-
properties:
|
|
1610
|
-
ids:
|
|
1611
|
-
$ref: '#/components/schemas/ids'
|
|
1612
|
-
collectionsFilter:
|
|
1613
|
-
type: object
|
|
1614
|
-
description: Only returns the collections specified
|
|
1615
|
-
properties:
|
|
1616
|
-
collections:
|
|
1617
|
-
$ref: '#/components/schemas/collectionsArray'
|
|
1618
|
-
providerFilter:
|
|
1619
|
-
type: string
|
|
1620
|
-
description: Only interrogate the specifiec provider
|
|
1621
|
-
queryFilter:
|
|
1622
|
-
description: An object representing a query filter.
|
|
1623
|
-
type: object
|
|
1624
|
-
properties:
|
|
1625
|
-
query:
|
|
1626
|
-
$ref: '#/components/schemas/query'
|
|
1627
|
-
datetime:
|
|
1628
|
-
type: string
|
|
1629
|
-
description: |-
|
|
1630
|
-
Either a date-time or an interval, open or closed. Date and time
|
|
1631
|
-
expressions adhere to RFC 3339. Open intervals are expressed using
|
|
1632
|
-
double-dots.
|
|
1633
|
-
|
|
1634
|
-
Examples:
|
|
1635
|
-
|
|
1636
|
-
* A date-time: `2023-10-12T23:20:50Z`
|
|
1637
|
-
* A closed interval: `2023-10-12T00:00:00Z/2023-11-10T12:31:12Z`
|
|
1638
|
-
* Open intervals: `2023-10-12T00:00:00Z/..` or `../2023-11-10T12:31:12Z`
|
|
1639
|
-
|
|
1640
|
-
Only features that have a temporal property that intersects the value of
|
|
1641
|
-
`datetime` are selected.
|
|
1642
|
-
|
|
1643
|
-
If a feature has multiple temporal properties, it is the decision of the
|
|
1644
|
-
server whether only a single temporal property is used to determine
|
|
1645
|
-
the extent or all relevant temporal properties.
|
|
1646
|
-
example: '2023-10-12T00:00:00Z/2023-11-10T12:31:12Z'
|
|
1647
|
-
stac_version:
|
|
1648
|
-
title: STAC version
|
|
1649
|
-
type: string
|
|
1650
|
-
example: 0.9.0
|
|
1651
|
-
stac_extensions:
|
|
1652
|
-
title: STAC extensions
|
|
1653
|
-
type: array
|
|
1654
|
-
uniqueItems: true
|
|
1655
|
-
items:
|
|
1656
|
-
anyOf:
|
|
1657
|
-
- title: Reference to a JSON Schema
|
|
1658
|
-
type: string
|
|
1659
|
-
format: uri
|
|
1660
|
-
- title: Reference to a core extension
|
|
1661
|
-
type: string
|
|
1662
|
-
itemCollection:
|
|
1663
|
-
description: >-
|
|
1664
|
-
A GeoJSON FeatureCollection augmented with foreign members that contain
|
|
1665
|
-
values relevant to a STAC entity
|
|
1666
|
-
type: object
|
|
1667
|
-
required:
|
|
1668
|
-
- features
|
|
1669
|
-
- type
|
|
1670
|
-
properties:
|
|
1671
|
-
type:
|
|
1672
|
-
type: string
|
|
1673
|
-
enum:
|
|
1674
|
-
- FeatureCollection
|
|
1675
|
-
features:
|
|
1676
|
-
type: array
|
|
1677
|
-
items:
|
|
1678
|
-
$ref: '#/components/schemas/item'
|
|
1679
|
-
links:
|
|
1680
|
-
$ref: '#/components/schemas/itemCollectionLinks'
|
|
1681
|
-
item:
|
|
1682
|
-
description: >-
|
|
1683
|
-
A GeoJSON Feature augmented with foreign members that contain values
|
|
1684
|
-
relevant to a STAC entity
|
|
1685
|
-
type: object
|
|
1686
|
-
required:
|
|
1687
|
-
- stac_version
|
|
1688
|
-
- id
|
|
1689
|
-
- type
|
|
1690
|
-
- geometry
|
|
1691
|
-
- bbox
|
|
1692
|
-
- links
|
|
1693
|
-
- properties
|
|
1694
|
-
- assets
|
|
1695
|
-
properties:
|
|
1696
|
-
stac_version:
|
|
1697
|
-
$ref: '#/components/schemas/stac_version'
|
|
1698
|
-
stac_extensions:
|
|
1699
|
-
$ref: '#/components/schemas/stac_extensions'
|
|
1700
|
-
id:
|
|
1701
|
-
$ref: '#/components/schemas/itemId'
|
|
1702
|
-
bbox:
|
|
1703
|
-
$ref: '#/components/schemas/bbox'
|
|
1704
|
-
geometry:
|
|
1705
|
-
$ref: 'https://geojson.org/schema/Geometry.json'
|
|
1706
|
-
type:
|
|
1707
|
-
$ref: '#/components/schemas/itemType'
|
|
1708
|
-
properties:
|
|
1709
|
-
$ref: '#/components/schemas/itemProperties'
|
|
1710
|
-
links:
|
|
1711
|
-
type: array
|
|
1712
|
-
items:
|
|
1713
|
-
$ref: '#/components/schemas/link'
|
|
1714
|
-
assets:
|
|
1715
|
-
$ref: '#/components/schemas/itemAssets'
|
|
1716
|
-
example:
|
|
1717
|
-
stac_version: 0.9.0
|
|
1718
|
-
stac_extensions:
|
|
1719
|
-
- eo
|
|
1720
|
-
- view
|
|
1721
|
-
- 'https://example.com/cs-extension/1.0/schema.json'
|
|
1722
|
-
type: Feature
|
|
1723
|
-
id: CS3-20160503_132131_05
|
|
1724
|
-
bbox:
|
|
1725
|
-
- -122.59750209
|
|
1726
|
-
- 37.48803556
|
|
1727
|
-
- -122.2880486
|
|
1728
|
-
- 37.613537207
|
|
1729
|
-
geometry:
|
|
1730
|
-
type: Polygon
|
|
1731
|
-
coordinates:
|
|
1732
|
-
- - - -122.308150179
|
|
1733
|
-
- 37.488035566
|
|
1734
|
-
- - -122.597502109
|
|
1735
|
-
- 37.538869539
|
|
1736
|
-
- - -122.576687533
|
|
1737
|
-
- 37.613537207
|
|
1738
|
-
- - -122.2880486
|
|
1739
|
-
- 37.562818007
|
|
1740
|
-
- - -122.308150179
|
|
1741
|
-
- 37.488035566
|
|
1742
|
-
properties:
|
|
1743
|
-
datetime: '2016-05-03T13:22:30.040Z'
|
|
1744
|
-
title: A CS3 item
|
|
1745
|
-
license: PDDL-1.0
|
|
1746
|
-
providers:
|
|
1747
|
-
- name: CoolSat
|
|
1748
|
-
roles:
|
|
1749
|
-
- producer
|
|
1750
|
-
- licensor
|
|
1751
|
-
url: 'https://cool-sat.com/'
|
|
1752
|
-
'view:sun_azimuth': 168.7
|
|
1753
|
-
'eo:cloud_cover': 0.12
|
|
1754
|
-
'view:off_nadir': 1.4
|
|
1755
|
-
platform: coolsat2
|
|
1756
|
-
instruments:
|
|
1757
|
-
- cool_sensor_v1
|
|
1758
|
-
'eo:bands': []
|
|
1759
|
-
'view:sun_elevation': 33.4
|
|
1760
|
-
'eo:gsd': 0.512
|
|
1761
|
-
collection: CS3
|
|
1762
|
-
links:
|
|
1763
|
-
- rel: self
|
|
1764
|
-
href: 'http://cool-sat.com/collections/CS3/items/20160503_132130_04'
|
|
1765
|
-
- rel: root
|
|
1766
|
-
href: 'http://cool-sat.com/collections'
|
|
1767
|
-
- rel: parent
|
|
1768
|
-
href: 'http://cool-sat.com/collections/CS3'
|
|
1769
|
-
- rel: collection
|
|
1770
|
-
href: 'http://cool-sat.com/collections/CS3'
|
|
1771
|
-
assets:
|
|
1772
|
-
analytic:
|
|
1773
|
-
href: >-
|
|
1774
|
-
http://cool-sat.com/static-catalog/CS3/20160503_132130_04/analytic.tif
|
|
1775
|
-
title: 4-Band Analytic
|
|
1776
|
-
thumbnail:
|
|
1777
|
-
href: >-
|
|
1778
|
-
http://cool-sat.com/static-catalog/CS3/20160503_132130_04/thumbnail.png
|
|
1779
|
-
title: Thumbnail
|
|
1780
|
-
itemId:
|
|
1781
|
-
type: string
|
|
1782
|
-
example: path/to/example.tif
|
|
1783
|
-
description: 'Provider identifier, a unique ID, potentially a link to a file.'
|
|
1784
|
-
itemType:
|
|
1785
|
-
type: string
|
|
1786
|
-
description: The GeoJSON type
|
|
1787
|
-
enum:
|
|
1788
|
-
- Feature
|
|
1789
|
-
itemAssets:
|
|
1790
|
-
type: object
|
|
1791
|
-
additionalProperties:
|
|
1792
|
-
type: object
|
|
1793
|
-
required:
|
|
1794
|
-
- href
|
|
1795
|
-
properties:
|
|
1796
|
-
href:
|
|
1797
|
-
type: string
|
|
1798
|
-
format: url
|
|
1799
|
-
description: Link to the asset object
|
|
1800
|
-
example: >-
|
|
1801
|
-
http://cool-sat.com/catalog/collections/cs/items/CS3-20160503_132130_04/thumb.png
|
|
1802
|
-
title:
|
|
1803
|
-
type: string
|
|
1804
|
-
description: Displayed title
|
|
1805
|
-
example: Thumbnail
|
|
1806
|
-
description:
|
|
1807
|
-
type: string
|
|
1808
|
-
description: |-
|
|
1809
|
-
Multi-line description to explain the asset.
|
|
1810
|
-
|
|
1811
|
-
[CommonMark 0.29](http://commonmark.org/) syntax MAY be used for
|
|
1812
|
-
rich text representation.
|
|
1813
|
-
example: Small 256x256px PNG thumbnail for a preview.
|
|
1814
|
-
type:
|
|
1815
|
-
type: string
|
|
1816
|
-
description: Media type of the asset
|
|
1817
|
-
example: image/png
|
|
1818
|
-
roles:
|
|
1819
|
-
type: array
|
|
1820
|
-
items:
|
|
1821
|
-
type: string
|
|
1822
|
-
description: Purposes of the asset
|
|
1823
|
-
example:
|
|
1824
|
-
- thumbnail
|
|
1825
|
-
itemProperties:
|
|
1826
|
-
type: object
|
|
1827
|
-
required:
|
|
1828
|
-
- datetime
|
|
1829
|
-
description: provides the core metatdata fields plus extensions
|
|
1830
|
-
properties:
|
|
1831
|
-
datetime:
|
|
1832
|
-
$ref: '#/components/schemas/datetime'
|
|
1833
|
-
additionalProperties:
|
|
1834
|
-
description: >-
|
|
1835
|
-
Any additional properties added in via Item specification or
|
|
1836
|
-
extensions.
|
|
1837
|
-
itemCollectionLinks:
|
|
1838
|
-
type: array
|
|
1839
|
-
description: >-
|
|
1840
|
-
An array of links. Can be used for pagination, e.g. by providing a link
|
|
1841
|
-
with the `next` relation type.
|
|
1842
|
-
items:
|
|
1843
|
-
$ref: '#/components/schemas/link'
|
|
1844
|
-
example:
|
|
1845
|
-
- rel: next
|
|
1846
|
-
href: >-
|
|
1847
|
-
http://api.cool-sat.com/search?next=ANsXtp9mrqN0yrKWhf-y2PUpHRLQb1GT-mtxNcXou8TwkXhi1Jbk
|
|
1848
|
-
responses:
|
|
1849
|
-
LandingPage:
|
|
1850
|
-
description: |-
|
|
1851
|
-
The landing page provides links to the API definition
|
|
1852
|
-
(link relations `service-desc` and `service-doc`),
|
|
1853
|
-
the Conformance declaration (path `/conformance`,
|
|
1854
|
-
link relation `conformance`), and the Feature
|
|
1855
|
-
Collections (path `/collections`, link relation
|
|
1856
|
-
`data`).
|
|
1857
|
-
|
|
1858
|
-
Links to the search endpoints (path `/search`, link relation `search`,
|
|
1859
|
-
method `GET` or `POST`) are **required** to be specified if the API
|
|
1860
|
-
implements `/search` for any of the specified HTTP methods.
|
|
1861
|
-
content:
|
|
1862
|
-
application/json:
|
|
1863
|
-
schema:
|
|
1864
|
-
$ref: '#/components/schemas/landingPage'
|
|
1865
|
-
example:
|
|
1866
|
-
title: NAIP Imagery
|
|
1867
|
-
description: Catalog of NAIP Imagery.
|
|
1868
|
-
links:
|
|
1869
|
-
- href: 'http://data.example.org/'
|
|
1870
|
-
rel: self
|
|
1871
|
-
type: application/json
|
|
1872
|
-
title: this document
|
|
1873
|
-
- href: 'http://data.example.org/api'
|
|
1874
|
-
rel: service-desc
|
|
1875
|
-
type: application/vnd.oai.openapi+json;version=3.0
|
|
1876
|
-
title: the API definition
|
|
1877
|
-
- href: 'http://data.example.org/api.html'
|
|
1878
|
-
rel: service-doc
|
|
1879
|
-
type: text/html
|
|
1880
|
-
title: the API documentation
|
|
1881
|
-
- href: 'http://data.example.org/conformance'
|
|
1882
|
-
rel: conformance
|
|
1883
|
-
type: application/json
|
|
1884
|
-
title: OGC API conformance classes implemented by this server
|
|
1885
|
-
- href: 'http://data.example.org/collections'
|
|
1886
|
-
rel: data
|
|
1887
|
-
type: application/json
|
|
1888
|
-
title: Information about the feature collections
|
|
1889
|
-
- href: 'http://data.example.org/search'
|
|
1890
|
-
rel: search
|
|
1891
|
-
type: application/json
|
|
1892
|
-
title: Search across feature collections
|
|
1893
|
-
stac_version: 0.9.0
|
|
1894
|
-
id: naip
|
|
1895
|
-
text/html:
|
|
1896
|
-
schema:
|
|
1897
|
-
type: string
|
|
1898
|
-
ConformanceDeclaration:
|
|
1899
|
-
description: |-
|
|
1900
|
-
The URIs of all conformance classes supported by the server.
|
|
1901
|
-
|
|
1902
|
-
To support "generic" clients that want to access multiple
|
|
1903
|
-
OGC API Features implementations - and not "just" a specific
|
|
1904
|
-
API / server, the server declares the conformance
|
|
1905
|
-
classes it implements and conforms to.
|
|
1906
|
-
content:
|
|
1907
|
-
application/json:
|
|
1908
|
-
schema:
|
|
1909
|
-
$ref: '#/components/schemas/confClasses'
|
|
1910
|
-
example:
|
|
1911
|
-
conformsTo:
|
|
1912
|
-
- 'http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/core'
|
|
1913
|
-
- 'http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/oas30'
|
|
1914
|
-
- 'http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/html'
|
|
1915
|
-
- 'http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/geojson'
|
|
1916
|
-
text/html:
|
|
1917
|
-
schema:
|
|
1918
|
-
type: string
|
|
1919
|
-
Accepted:
|
|
1920
|
-
description: The request has been accepted, but the data is not yet ready. Please wait a few minutes before trying again.
|
|
1921
|
-
content:
|
|
1922
|
-
application/json:
|
|
1923
|
-
schema:
|
|
1924
|
-
$ref: '#/components/schemas/exception'
|
|
1925
|
-
Collections:
|
|
1926
|
-
description: >-
|
|
1927
|
-
The feature collections shared by this API.
|
|
1928
|
-
|
|
1929
|
-
|
|
1930
|
-
The dataset is organized as one or more feature collections. This
|
|
1931
|
-
resource
|
|
1932
|
-
|
|
1933
|
-
provides information about and access to the collections.
|
|
1934
|
-
|
|
1935
|
-
|
|
1936
|
-
The response contains the list of collections. For each collection, a
|
|
1937
|
-
link
|
|
1938
|
-
|
|
1939
|
-
to the items in the collection (path
|
|
1940
|
-
`/collections/{collectionId}/items`,
|
|
1941
|
-
|
|
1942
|
-
link relation `items`) as well as key information about the collection.
|
|
1943
|
-
|
|
1944
|
-
This information includes:
|
|
1945
|
-
|
|
1946
|
-
|
|
1947
|
-
* A local identifier for the collection that is unique for the dataset;
|
|
1948
|
-
|
|
1949
|
-
* A list of coordinate reference systems (CRS) in which geometries may
|
|
1950
|
-
be returned by the server. The first CRS is the default coordinate
|
|
1951
|
-
reference system (the default is always WGS 84 with axis order
|
|
1952
|
-
longitude/latitude);
|
|
1953
|
-
|
|
1954
|
-
* An optional title and description for the collection;
|
|
1955
|
-
|
|
1956
|
-
* An optional extent that can be used to provide an indication of the
|
|
1957
|
-
spatial and temporal extent of the collection - typically derived from
|
|
1958
|
-
the data;
|
|
1959
|
-
|
|
1960
|
-
* An optional indicator about the type of the items in the collection
|
|
1961
|
-
(the default value, if the indicator is not provided, is 'feature').
|
|
1962
|
-
content:
|
|
1963
|
-
application/json:
|
|
1964
|
-
schema:
|
|
1965
|
-
$ref: '#/components/schemas/collections'
|
|
1966
|
-
text/html:
|
|
1967
|
-
schema:
|
|
1968
|
-
type: string
|
|
1969
|
-
Collection:
|
|
1970
|
-
description: >-
|
|
1971
|
-
Information about the feature collection with id `collectionId`.
|
|
1972
|
-
|
|
1973
|
-
|
|
1974
|
-
The response contains a link to the items in the collection
|
|
1975
|
-
|
|
1976
|
-
(path `/collections/{collectionId}/items`, link relation `items`)
|
|
1977
|
-
|
|
1978
|
-
as well as key information about the collection. This information
|
|
1979
|
-
|
|
1980
|
-
includes:
|
|
1981
|
-
|
|
1982
|
-
|
|
1983
|
-
* A local identifier for the collection that is unique for the dataset;
|
|
1984
|
-
|
|
1985
|
-
* A list of coordinate reference systems (CRS) in which geometries may
|
|
1986
|
-
be returned by the server. The first CRS is the default coordinate
|
|
1987
|
-
reference system (the default is always WGS 84 with axis order
|
|
1988
|
-
longitude/latitude);
|
|
1989
|
-
|
|
1990
|
-
* An optional title and description for the collection;
|
|
1991
|
-
|
|
1992
|
-
* An optional extent that can be used to provide an indication of the
|
|
1993
|
-
spatial and temporal extent of the collection - typically derived from
|
|
1994
|
-
the data;
|
|
1995
|
-
|
|
1996
|
-
* An optional indicator about the type of the items in the collection
|
|
1997
|
-
(the default value, if the indicator is not provided, is 'feature').
|
|
1998
|
-
content:
|
|
1999
|
-
application/json:
|
|
2000
|
-
schema:
|
|
2001
|
-
$ref: '#/components/schemas/collection'
|
|
2002
|
-
text/html:
|
|
2003
|
-
schema:
|
|
2004
|
-
type: string
|
|
2005
|
-
Features:
|
|
2006
|
-
description: >-
|
|
2007
|
-
The response is a document consisting of features in the collection.
|
|
2008
|
-
|
|
2009
|
-
The features included in the response are determined by the server
|
|
2010
|
-
|
|
2011
|
-
based on the query parameters of the request. To support access to
|
|
2012
|
-
|
|
2013
|
-
larger collections without overloading the client, the API supports
|
|
2014
|
-
|
|
2015
|
-
paged access with links to the next page, if more features are selected
|
|
2016
|
-
|
|
2017
|
-
that the page size.
|
|
2018
|
-
|
|
2019
|
-
|
|
2020
|
-
The `bbox` and `datetime` parameter can be used to select only a
|
|
2021
|
-
|
|
2022
|
-
subset of the features in the collection (the features that are in the
|
|
2023
|
-
|
|
2024
|
-
bounding box or time interval). The `bbox` parameter matches all
|
|
2025
|
-
features
|
|
2026
|
-
|
|
2027
|
-
in the collection that are not associated with a location, too. The
|
|
2028
|
-
|
|
2029
|
-
`datetime` parameter matches all features in the collection that are
|
|
2030
|
-
|
|
2031
|
-
not associated with a time stamp or interval, too.
|
|
2032
|
-
|
|
2033
|
-
|
|
2034
|
-
The `limit` parameter may be used to control the subset of the
|
|
2035
|
-
|
|
2036
|
-
selected features that should be returned in the response, the page
|
|
2037
|
-
size.
|
|
2038
|
-
|
|
2039
|
-
Each page may include information about the number of selected and
|
|
2040
|
-
|
|
2041
|
-
returned features (`numberMatched` and `numberReturned`) as well as
|
|
2042
|
-
|
|
2043
|
-
links to support paging (link relation `next`).
|
|
2044
|
-
content:
|
|
2045
|
-
application/geo+json:
|
|
2046
|
-
schema:
|
|
2047
|
-
$ref: '#/components/schemas/featureCollectionGeoJSON'
|
|
2048
|
-
text/html:
|
|
2049
|
-
schema:
|
|
2050
|
-
type: string
|
|
2051
|
-
Feature:
|
|
2052
|
-
description: |-
|
|
2053
|
-
fetch the feature with id `featureId` in the feature collection
|
|
2054
|
-
with id `collectionId`
|
|
2055
|
-
content:
|
|
2056
|
-
application/geo+json:
|
|
2057
|
-
schema:
|
|
2058
|
-
$ref: '#/components/schemas/item'
|
|
2059
|
-
text/html:
|
|
2060
|
-
schema:
|
|
2061
|
-
type: string
|
|
2062
|
-
InvalidParameter:
|
|
2063
|
-
description: A query parameter has an invalid value.
|
|
2064
|
-
content:
|
|
2065
|
-
application/json:
|
|
2066
|
-
schema:
|
|
2067
|
-
$ref: '#/components/schemas/exception'
|
|
2068
|
-
text/html:
|
|
2069
|
-
schema:
|
|
2070
|
-
type: string
|
|
2071
|
-
NotFound:
|
|
2072
|
-
description: The requested URI was not found.
|
|
2073
|
-
content:
|
|
2074
|
-
application/json:
|
|
2075
|
-
schema:
|
|
2076
|
-
$ref: '#/components/schemas/exception'
|
|
2077
|
-
Queryables:
|
|
2078
|
-
description: A JSON Schema defining the Queryables allowed in filter expressions
|
|
2079
|
-
content:
|
|
2080
|
-
application/schema+json:
|
|
2081
|
-
schema:
|
|
2082
|
-
type: object
|
|
2083
|
-
ServerError:
|
|
2084
|
-
description: A server error occurred.
|
|
2085
|
-
content:
|
|
2086
|
-
application/json:
|
|
2087
|
-
schema:
|
|
2088
|
-
$ref: '#/components/schemas/exception'
|
|
2089
|
-
text/html:
|
|
2090
|
-
schema:
|
|
2091
|
-
type: string
|
|
2092
|
-
servers:
|
|
2093
|
-
- url: 'http://dev.cool-sat.com'
|
|
2094
|
-
description: Development server
|
|
2095
|
-
- url: 'http://www.cool-sat.com'
|
|
2096
|
-
description: Production server
|
|
2097
|
-
tags:
|
|
2098
|
-
- name: Capabilities
|
|
2099
|
-
description: essential characteristics of this API
|
|
2100
|
-
- name: Data
|
|
2101
|
-
description: access to data (features)
|
|
2102
|
-
- name: STAC
|
|
2103
|
-
description: >-
|
|
2104
|
-
Extension to OGC API - Features to support STAC metadata model and search
|
|
2105
|
-
API
|