forked from radiantearth/stac-spec
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathSTAC-standalone.yaml
485 lines (453 loc) · 14.4 KB
/
STAC-standalone.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
openapi: 3.0.1
info:
title: The SpatioTemporal Asset Catalog API (standalone)
version: 0.5.1
description: >-
This is an OpenAPI definition of the core SpatioTemporal Asset Catalog API
specification. Any service that implements this endpoint to allow search of
spatiotemporal assets can be considered a STAC API. The endpoint is also
available as an OpenAPI fragment that can be integrated with other OpenAPI
definitions, and is designed to slot seamless into a WFS 3 API definition.
contact:
name: Cool Sat Corp
email: [email protected]
url: 'http://cool-sat.com/contact/'
license:
name: CC-BY 4.0 license
url: 'https://creativecommons.org/licenses/by/4.0/'
servers:
- url: 'http://dev.cool-sat.com/'
description: Development server
- url: 'http://www.cool-sat.com'
description: Production server
paths:
/search/stac:
get:
summary: >-
retrieve items matching filters. Intended as a shorthand API for simple
queries. This method is optional.
operationId: getSearchSTAC
tags:
- STAC
parameters:
- $ref: '#/components/parameters/bbox'
- $ref: '#/components/parameters/time'
- $ref: '#/components/parameters/limit'
responses:
'200':
description: A feature collection.
content:
application/geo+json:
schema:
$ref: '#/components/schemas/itemCollection'
text/html:
schema:
type: string
default:
description: An error occured.
content:
application/json:
schema:
$ref: '#/components/schemas/exception'
text/html:
schema:
type: string
post:
summary: >-
retrieve items matching filters. Intended as the standard, full-featured
query API. This method is mandatory.
operationId: postSearchSTAC
tags:
- STAC
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/searchBody'
responses:
'200':
description: A feature collection.
content:
application/geo+json:
schema:
$ref: '#/components/schemas/itemCollection'
text/html:
schema:
type: string
default:
description: An error occured.
content:
application/json:
schema:
$ref: '#/components/schemas/exception'
text/html:
schema:
type: string
components:
parameters:
limit:
name: limit
in: query
description: |
The optional limit parameter limits the number of items that are
presented in the response document.
Only items are counted that are on the first level of the collection in
the response document. Nested objects contained within the explicitly
requested items shall not be counted.
* Minimum = 1
* Maximum = 10000
* Default = 10
required: false
schema:
type: integer
minimum: 1
maximum: 10000
default: 10
style: form
explode: false
bbox:
name: bbox
in: query
description: |
Only features that have a geometry that intersects the bounding box are
selected. The bounding box is provided as four or six numbers,
depending on whether the coordinate reference system includes a
vertical axis (elevation or depth):
* Lower left corner, coordinate axis 1
* Lower left corner, coordinate axis 2
* Lower left corner, coordinate axis 3 (optional)
* Upper right corner, coordinate axis 1
* Upper right corner, coordinate axis 2
* Upper right corner, coordinate axis 3 (optional)
The coordinate reference system of the values is WGS84
longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84) unless
a different coordinate reference system is specified in the parameter
`bbox-crs`.
For WGS84 longitude/latitude the values are in most cases the sequence
of minimum longitude, minimum latitude, maximum longitude and maximum
latitude. However, in cases where the box spans the antimeridian the
first value (west-most box edge) is larger than the third value
(east-most box edge).
If a feature has multiple spatial geometry properties, it is the
decision of the server whether only a single spatial geometry property
is used to determine the extent or all relevant geometries.
required: false
schema:
type: array
minItems: 4
maxItems: 6
items:
type: number
style: form
explode: false
time:
name: time
in: query
description: >
Either a date-time or a period string that adheres to RFC3339. Examples:
* A date-time: "2018-02-12T23:20:50Z"
* A period: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" or
"2018-02-12T00:00:00Z/P1M6DT12H31M12S"
Only features that have a temporal property that intersects the value
of
`time` are selected. If a feature has multiple temporal properties, it
is
the decision of the server whether only a single temporal property is
used to
determine the extent or all relevant temporal properties.
required: false
schema:
type: string
style: form
explode: false
collectionId:
name: collectionId
in: path
required: true
description: Identifier (name) of a specific collection
schema:
type: string
featureId:
name: featureId
in: path
description: Local identifier of a specific feature
required: true
schema:
type: string
schemas:
exception:
type: object
required:
- code
properties:
code:
type: string
description:
type: string
link:
type: object
required:
- href
properties:
href:
type: string
rel:
type: string
example: prev
searchBody:
description: The search criteria
type: object
allOf:
- $ref: '#/components/schemas/bboxFilter'
- $ref: '#/components/schemas/timeFilter'
- $ref: '#/components/schemas/intersectsFilter'
- type: object
properties:
limit:
type: number
example: 5
bbox:
description: |
Only features that have a geometry that intersects the bounding box are
selected. The bounding box is provided as four or six numbers,
depending on whether the coordinate reference system includes a
vertical axis (elevation or depth):
* Lower left corner, coordinate axis 1
* Lower left corner, coordinate axis 2
* Lower left corner, coordinate axis 3 (optional)
* Upper right corner, coordinate axis 1
* Upper right corner, coordinate axis 2
* Upper right corner, coordinate axis 3 (optional)
The coordinate reference system of the values is WGS84
longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84) unless
a different coordinate reference system is specified in the parameter
`bbox-crs`.
For WGS84 longitude/latitude the values are in most cases the sequence
of minimum longitude, minimum latitude, maximum longitude and maximum
latitude. However, in cases where the box spans the antimeridian the
first value (west-most box edge) is larger than the third value
(east-most box edge).
If a feature has multiple spatial geometry properties, it is the
decision of the server whether only a single spatial geometry property
is used to determine the extent or all relevant geometries.
type: array
minItems: 4
maxItems: 6
items:
type: number
example:
- -110
- 39.5
- -105
- 40.5
bboxFilter:
type: object
description: Only return items that intersect the provided bounding box.
properties:
bbox:
$ref: '#/components/schemas/bbox'
timeFilter:
description: An object representing a time based filter.
type: object
properties:
time:
$ref: '#/components/schemas/time'
intersectsFilter:
type: object
description: Only returns items that intersect with the provided polygon.
properties:
intersects:
$ref: '#/components/schemas/polygon'
polygon:
type: object
properties:
type:
type: string
enum:
- polygon
coordinates:
$ref: '#/components/schemas/polygon2D'
required:
- type
- coordinates
polygon2D:
type: array
minItems: 1
items:
$ref: '#/components/schemas/linearRing2D'
linearRing2D:
type: array
minItems: 4
items:
$ref: '#/components/schemas/point2D'
example:
- - -104
- 35
- - -103
- 35
- - -103
- 34
- - -104
- 34
- - -104
- 35
point2D:
description: A 2d geojson point
type: array
minimum: 2
maximum: 2
items:
type: number
format: double
example:
- -104
- 35
time:
type: string
description: >
Either a date-time or a period string that adheres to RFC 3339.
Examples:
* A date-time: "2018-02-12T23:20:50Z"
* A period:
"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" or
"2018-02-12T00:00:00Z/P1M6DT12H31M12S"
Only features that have a temporal property that intersects the value of
`time` are selected.
If a feature has multiple temporal properties, it is the decision of the
server whether only a single temporal property is used to determine the
extent or all relevant temporal properties.
example: '2018-02-12T00:00:00Z/2018-03-18T12:31:12Z'
itemCollection:
type: object
required:
- features
- type
properties:
type:
type: string
enum:
- FeatureCollection
features:
type: array
items:
$ref: '#/components/schemas/item'
links:
$ref: '#/components/schemas/itemCollectionLinks'
item:
type: object
required:
- id
- type
- geometry
- links
- properties
- assets
properties:
id:
type: string
example: path/to/example.tif
description: 'unique ID, potentially link to file'
bbox:
$ref: '#/components/schemas/bbox'
geometry:
type: object
description: footprint of the item
type:
type: string
description: The GeoJSON type
enum:
- Feature
properties:
$ref: '#/components/schemas/itemProperties'
links:
type: object
additionalProperties:
type: object
required:
- href
- rel
properties:
href:
type: string
rel:
type: string
assets:
type: object
additionalProperties:
type: object
required:
- href
properties:
href:
type: string
name:
type: string
example:
type: Feature
id: CS3-20160503_132130_04
bbox:
- -122.59750209
- 37.48803556
- -122.2880486
- 37.613537207
geometry:
type: Polygon
coordinates:
- - - -122.308150179
- 37.488035566
- - -122.597502109
- 37.538869539
- - -122.576687533
- 37.613537207
- - -122.2880486
- 37.562818007
- - -122.308150179
- 37.488035566
properties:
datetime: '2016-05-03T13:21:30.040Z'
provider: 'http://www.cool-sat.com'
license: CC-BY-4.0
links:
self:
rel: self
href: >-
http://cool-sat.com/catalog/collections/cs/items/CS3-20160503_132130_04.json
assets:
analytic:
name: 4-Band Analytic
href: >-
http://cool-sat.com/catalog/collections/cs/items/CS3-20160503_132130_04/analytic.tif
thumbnail:
name: thumbnail
href: >-
http://cool-sat.com/catalog/collections/cs/items/CS3-20160503_132130_04/thumb.png
itemProperties:
type: object
required:
- datetime
description: provides the core metatdata fields plus extensions
properties:
datetime:
$ref: '#/components/schemas/time'
provider:
type: string
description: Information about the provider
license:
type: string
description: Data license name based on SPDX License List
additionalProperties:
type: object
itemCollectionLinks:
type: object
properties:
next:
type: string
format: url
description: >-
A URL to obtain the next paginated data set. If not present, the
client should utilize the `nextPageToken`.
example: >-
http://api.cool-sat.com/query/gasd312fsaeg/ANsXtp9mrqN0yrKWhf-y2PUpHRLQb1GT-mtxNcXou8TwkXhi1Jbk
tags:
- name: STAC
description: Extension to WFS3 Core to support STAC metadata model and search API