-
Notifications
You must be signed in to change notification settings - Fork 28
/
Copy pathopenapi.yaml
1938 lines (1757 loc) · 63.6 KB
/
openapi.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
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
title: STAC API
version: 1.0.0
description: >-
This is an OpenAPI definition of the SpatioTemporal Asset Catalog API specification.
contact:
name: STAC Specification
url: http://stacspec.org
license:
name: Apache License 2.0
url: http://www.apache.org/licenses/LICENSE-2.0
tags:
- name: Item Search
description: Search for Items
- name: Features
description: Retrieve Item and Collection resources
- name: Transaction
description: Execute transactions on Items
paths:
/:
get:
tags:
- Features
summary: landing page
description: >-
The landing page provides links to the sub-resources.
operationId: getLandingPage
responses:
'200':
$ref: '#/components/responses/LandingPage'
'500':
$ref: '#/components/responses/Error'
/collections:
get:
tags:
- Features
summary: the feature collections in the dataset
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.
operationId: getCollections
responses:
'200':
$ref: '#/components/responses/Collections'
'500':
$ref: '#/components/responses/ServerError'
/collections/{collectionId}:
get:
tags:
- Features
summary: describe the feature collection with id `collectionId`
description: >-
A single Feature Collection for the given if `collectionId`.
Request this endpoint to get a full list of metadata for the Feature Collection.
operationId: describeCollection
parameters:
- $ref: '#/components/parameters/collectionId'
responses:
'200':
$ref: '#/components/responses/Collection'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/ServerError'
/conformance:
get:
tags:
- Features
summary: information about specifications that this API conforms to
description: |-
A list of all conformance classes specified in a standard that the
server conforms to.
operationId: getConformanceDeclaration
responses:
'200':
$ref: '#/components/responses/ConformanceDeclaration'
'500':
$ref: '#/components/responses/ServerError'
/collections/{collectionId}/items:
get:
tags:
- Features
summary: fetch features
description: |-
Fetch features of the feature collection with id `collectionId`.
Every feature in a dataset belongs to a collection. A dataset may
consist of multiple feature collections. A feature collection is often a
collection of features of a similar type, based on a common schema.
operationId: getFeatures
parameters:
- $ref: '#/components/parameters/collectionId'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/bbox'
- $ref: '#/components/parameters/datetime'
responses:
'200':
$ref: '#/components/responses/Features'
'400':
$ref: '#/components/responses/InvalidParameter'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/ServerError'
parameters:
- $ref: '#/components/parameters/collectionId'
post:
summary: add a new STAC Item to a collection
description: create a new STAC Item in a specific collection
operationId: postFeature
tags:
- Transaction
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/item'
- $ref: '#/components/schemas/itemCollection'
responses:
'201':
description: Status of the create request.
headers:
Location:
description: >-
The URL of the newly added resource (i.e. path of the resource end point)
schema:
type: string
format: url
ETag:
schema:
type: string
description: A string to ensure the item has not been modified
content:
application/json:
schema:
$ref: '#/components/schemas/item'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/ServerError'
default:
description: An error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/exception'
/collections/{collectionId}/items/{featureId}:
get:
tags:
- Transaction
summary: fetch a single feature
description: |-
Fetch the feature with id `featureId` in the feature collection
with id `collectionId`.
operationId: getFeature
parameters:
- $ref: '#/components/parameters/collectionId'
- $ref: '#/components/parameters/featureId'
responses:
'200':
$ref: '#/components/responses/Feature'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/ServerError'
parameters:
- $ref: '#/components/parameters/collectionId'
- $ref: '#/components/parameters/featureId'
put:
summary: update an existing feature by Id with a complete item definition
description: >-
Use this method to update an existing feature. Requires the entire GeoJSON description be submitted.
operationId: updateFeature
tags:
- Transaction
parameters:
- $ref: '#/components/parameters/IfMatch'
requestBody:
description: >-
The request body shall contain a representation of the replacement item.
content:
application/json:
schema:
$ref: '#/components/schemas/item'
responses:
'204':
description: The item was replaced
headers:
ETag:
schema:
type: string
description: An updated string to track changes
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'412':
$ref: '#/components/responses/PreconditionFailed'
'500':
$ref: '#/components/responses/ServerError'
default:
description: An error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/exception'
patch:
summary: update an existing feature by Id with a partial item definition
description: >-
Use this method to update an existing feature. Requires a GeoJSON fragment (containing the fields to be updated) be submitted.
operationId: patchFeature
tags:
- Transaction
parameters:
- $ref: '#/components/parameters/IfMatchOptional'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/partialItem'
responses:
'204':
description: Status of the update request.
headers:
ETag:
schema:
type: string
description: A string to ensure the item has not been modified
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/ServerError'
default:
description: An error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/exception'
delete:
summary: delete an existing feature by Id
description: Use this method to delete an existing feature.
operationId: deleteFeature
tags:
- Transaction
parameters:
- $ref: '#/components/parameters/IfMatch'
responses:
'204':
description: The resource was deleted.
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/ServerError'
default:
description: An error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/exception'
/search:
get:
summary: Search STAC items with simple filtering.
operationId: getItemSearch
description: |-
Retrieve Items matching filters. Intended as a shorthand API for simple
queries.
This method is required to implement.
If this endpoint is implemented on a server, it is required to add a
link referring to this endpoint with `rel` set to `search` to the
`links` array in `GET /`. As `GET` is the default method, the `method`
may not be set explicitly in the link.
tags:
- Item Search
parameters:
- $ref: '#/components/parameters/bbox'
- $ref: '#/components/parameters/intersects'
- $ref: '#/components/parameters/datetime'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/ids'
- $ref: '#/components/parameters/collectionsArray'
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/sortby'
responses:
'200':
description: A feature collection.
content:
application/geo+json:
schema:
allOf:
- $ref: '#/components/schemas/itemCollection'
- $ref: '#/components/schemas/schemas-itemCollection'
text/html:
schema:
type: string
default:
$ref: '#/components/responses/Error'
post:
summary: Search STAC items with full-featured filtering.
operationId: postItemSearch
description: |-
Retrieve items matching filters. Intended as the standard, full-featured
query API.
This method is optional to implement, but recommended.
If this endpoint is implemented on a server, it is required to add a
link referring to this endpoint with `rel` set to `search` and `method`
set to `POST` to the `links` array in `GET /`.
tags:
- Item Search
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/searchBody'
- $ref: '#/components/schemas/schemas-searchBody'
- $ref: '#/components/schemas/openapi_components-schemas-searchBody'
responses:
'200':
description: A feature collection.
content:
application/geo+json:
schema:
$ref: '#/components/schemas/itemCollection'
text/html:
schema:
type: string
default:
$ref: '#/components/responses/Error'
components:
schemas:
landingPage:
allOf:
- $ref: '#/components/schemas/catalog'
- $ref: '#/components/schemas/conformanceClasses'
stac_version:
title: STAC version
type: string
example: 1.0.0
stac_extensions:
title: STAC extensions
type: array
uniqueItems: true
items:
anyOf:
- title: Reference to a JSON Schema
type: string
format: uri
- title: Reference to a core extension
type: string
link:
title: Link
type: object
required:
- href
- rel
properties:
href:
type: string
format: uri
description: The location of the resource
rel:
type: string
description: Relation type of the link
type:
type: string
description: The media type of the resource
title:
type: string
description: Title of the resource
method:
type: string
enum:
- GET
- POST
default: GET
description: Specifies the HTTP method that the resource expects
headers:
type: object
description: Object key values pairs they map to headers
example:
Accept: application/json
body:
type: object
description: >-
For POST requests, the resource can specify the HTTP body as a JSON object.
merge:
type: boolean
default: false
description: |-
This is only valid when the server is responding to POST request.
If merge is true, the client is expected to merge the body value
into the current request body before following the link.
This avoids passing large post bodies back and forth when following
links, particularly for navigating pages through the `POST /search`
endpoint.
NOTE: To support form encoding it is expected that a client be able
to merge in the key value pairs specified as JSON
`{"next": "token"}` will become `&next=token`.
links:
type: array
items:
$ref: '#/components/schemas/link'
catalog:
type: object
required:
- stac_version
- type
- id
- description
- links
properties:
stac_version:
$ref: '#/components/schemas/stac_version'
stac_extensions:
$ref: '#/components/schemas/stac_extensions'
type:
type: string
id:
type: string
title:
type: string
description:
type: string
links:
$ref: '#/components/schemas/links'
conformanceClasses:
type: object
required:
- conformsTo
properties:
conformsTo:
description: >-
A list of all conformance classes implemented by the server. In addition to the STAC-specific conformance classes, all OGC-related conformance classes listed at `GET /conformances` must be listed here. This entry should mirror what `GET /conformances` returns, if implemented.
type: array
items:
type: string
exception:
type: object
description: >-
Information about the exception: an error code plus an optional description.
required:
- code
properties:
code:
type: string
description:
type: string
collections:
type: object
required:
- links
- collections
properties:
links:
$ref: '#/components/schemas/links'
collections:
type: array
items:
$ref: '#/components/schemas/collection'
license:
type: string
description: |-
License(s) of the data as a SPDX
[License identifier](https://spdx.org/licenses/). Alternatively, use
`proprietary` if the license is not on the SPDX license list or
`various` if multiple licenses apply. In these two cases links to the
license texts SHOULD be added, see the `license` link relation type.
Non-SPDX licenses SHOULD add a link to the license text with the
`license` relation in the links section. The license text MUST NOT be
provided as a value of this field. If there is no public license URL
available, it is RECOMMENDED to host the license text and
link to it.
example: Apache-2.0
extent:
type: object
description: "The extent of the features in the collection. In the Core only spatial and temporal\nextents are specified. Extensions may add additional members to represent other\nextents, for example, thermal or pressure ranges.\n\nThe first item in the array describes the overall extent of\nthe data. All subsequent items describe more precise extents, \ne.g., to identify clusters of data.\nClients only interested in the overall extent will only need to\naccess the first item in each array."
required:
- spatial
- temporal
properties:
spatial:
description: The spatial extent of the features in the collection.
type: object
required:
- bbox
properties:
bbox:
description: "One or more bounding boxes that describe the spatial extent of the dataset.\n\nThe first bounding box describes the overall spatial\nextent of the data. All subsequent bounding boxes describe \nmore precise bounding boxes, e.g., to identify clusters of data.\nClients only interested in the overall spatial extent will\nonly need to access the first item in each array."
type: array
minItems: 1
items:
description: >-
Each bounding box is provided as four or six numbers, depending on
whether the coordinate reference system includes a vertical axis
(height or depth):
* Lower left corner, coordinate axis 1
* Lower left corner, coordinate axis 2
* Minimum value, coordinate axis 3 (optional)
* Upper right corner, coordinate axis 1
* Upper right corner, coordinate axis 2
* Maximum value, coordinate axis 3 (optional)
The coordinate reference system of the values is WGS 84 longitude/latitude
(http://www.opengis.net/def/crs/OGC/1.3/CRS84) unless a different coordinate
reference system is specified in `crs`.
For WGS 84 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 the vertical axis is included, the third and the sixth number are
the bottom and the top of the 3-dimensional bounding box.
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:
- -180
- -90
- 180
- 90
crs:
description: >-
Coordinate reference system of the coordinates in the spatial extent
(property `bbox`). The default reference system is WGS 84 longitude/latitude.
In the Core this is the only supported coordinate reference system.
Extensions may support additional coordinate reference systems and add
additional enum values.
type: string
enum:
- http://www.opengis.net/def/crs/OGC/1.3/CRS84
default: http://www.opengis.net/def/crs/OGC/1.3/CRS84
temporal:
description: The temporal extent of the features in the collection.
type: object
required:
- interval
properties:
interval:
description: "One or more time intervals that describe the temporal extent of the dataset.\n\nThe first time interval describes the overall\ntemporal extent of the data. All subsequent time intervals describe \nmore precise time intervals, e.g., to identify clusters of data.\nClients only interested in the overall extent will only need\nto access the first item in each array."
type: array
minItems: 1
items:
description: >-
Begin and end times of the time interval. The timestamps
are in the coordinate reference system specified in `trs`. By default
this is the Gregorian calendar.
The value `null` is supported and indicates an open time interval.
type: array
minItems: 2
maxItems: 2
items:
type: string
format: date-time
nullable: true
example:
- 2011-11-11T12:22:11Z
- null
trs:
description: >-
Coordinate reference system of the coordinates in the temporal extent
(property `interval`). The default reference system is the Gregorian calendar.
In the Core this is the only supported temporal reference system.
Extensions may support additional temporal reference systems and add
additional enum values.
type: string
enum:
- http://www.opengis.net/def/uom/ISO-8601/0/Gregorian
default: http://www.opengis.net/def/uom/ISO-8601/0/Gregorian
providers:
type: array
description: >-
A list of providers, which may include all organizations capturing or processing the data or the hosting provider. Providers should be listed in chronological order with the most recent provider being the last element of the list.
items:
type: object
title: Provider
required:
- name
properties:
name:
description: The name of the organization or the individual.
type: string
description:
description: >-
Multi-line description to add further provider information such as processing details for processors and producers, hosting details for hosts or basic contact information.
[CommonMark 0.29](http://commonmark.org/) syntax MAY be used for rich text representation.
type: string
roles:
description: |-
Roles of the provider.
The provider's role(s) can be one or more of the following
elements:
* licensor: The organization that is licensing the dataset under
the license specified in the collection's license field.
* producer: The producer of the data is the provider that
initially captured and processed the source data, e.g. ESA for
Sentinel-2 data.
* processor: A processor is any provider who processed data to a
derived product.
* host: The host is the actual provider offering the data on their
storage. There should be no more than one host, specified as last
element of the list.
type: array
items:
type: string
enum:
- producer
- licensor
- processor
- host
url:
description: >-
Homepage on which the provider describes the dataset and publishes contact information.
type: string
format: url
collection:
type: object
required:
- stac_version
- type
- id
- description
- license
- extent
- links
properties:
stac_version:
$ref: '#/components/schemas/stac_version'
stac_extensions:
$ref: '#/components/schemas/stac_extensions'
type:
type: string
id:
description: identifier of the collection used, for example, in URIs
type: string
title:
description: human readable title of the collection
type: string
description:
type: string
description: >-
Detailed multi-line description to fully explain the catalog or collection.
[CommonMark 0.29](http://commonmark.org/) syntax MAY be used for rich text representation.
keywords:
type: array
description: List of keywords describing the collection.
items:
type: string
license:
$ref: '#/components/schemas/license'
extent:
$ref: '#/components/schemas/extent'
providers:
$ref: '#/components/schemas/providers'
links:
$ref: '#/components/schemas/links'
summaries:
description: |-
Summaries are either a unique set of all available values *or*
statistics. Statistics by default only specify the range (minimum
and maximum values), but can optionally be accompanied by additional
statistical values. The range can specify the potential range of
values, but it is recommended to be as precise as possible. The set
of values must contain at least one element and it is strongly
recommended to list all values. It is recommended to list as many
properties as reasonable so that consumers get a full overview of
the Collection. Properties that are covered by the Collection
specification (e.g. `providers` and `license`) may not be repeated
in the summaries.
type: object
additionalProperties:
oneOf:
- type: array
title: Set of values
items:
description: A value of any type.
- type: object
title: Statistics
description: |-
By default, only ranges with a minimum and a maximum value can
be specified. Ranges can be specified for ordinal values only,
which means they need to have a rank order. Therefore, ranges
can only be specified for numbers and some special types of
strings. Examples: grades (A to F), dates or times.
Implementors are free to add other derived statistical values
to the object, for example `mean` or `stddev`.
required:
- min
- max
properties:
min:
anyOf:
- type: string
- type: number
max:
anyOf:
- type: string
- type: number
example:
stac_version: 1.0.0
stac_extensions: []
type: Collection
id: Sentinel-2
title: 'Sentinel-2 MSI: MultiSpectral Instrument, Level-1C'
description: |
Sentinel-2 is a wide-swath, high-resolution, multi-spectral
imaging mission...
license: proprietary
keywords:
- copernicus
- esa
- eu
- msi
- radiance
- sentinel
providers:
- name: ESA
roles:
- producer
- licensor
url: https://sentinel.esa.int/web/sentinel/user-guides/sentinel-2-msi
extent:
spatial:
bbox:
- - -180
- -56
- 180
- 83
temporal:
interval:
- - 2015-06-23T00:00:00Z
- 2019-07-10T13:44:56Z
summaries:
datetime:
min: 2015-06-23T00:00:00Z
max: 2019-07-10T13:44:56Z
sci:citation:
- Copernicus Sentinel data [Year]
eo:gsd:
- 10
- 30
- 60
platform:
- sentinel-2a
- sentinel-2b
constellation:
- sentinel-2
instruments:
- msi
view:off_nadir:
min: 0
max: 100
view:sun_elevation:
min: 6.78
max: 89.9
eo:bands:
- - name: B1
common_name: coastal
center_wavelength: 4.439
- name: B2
common_name: blue
center_wavelength: 4.966
- name: B3
common_name: green
center_wavelength: 5.6
- name: B4
common_name: red
center_wavelength: 6.645
- name: B5
center_wavelength: 7.039
- name: B6
center_wavelength: 7.402
- name: B7
center_wavelength: 7.825
- name: B8
common_name: nir
center_wavelength: 8.351
- name: B8A
center_wavelength: 8.648
- name: B9
center_wavelength: 9.45
- name: B10
center_wavelength: 1.3735
- name: B11
common_name: swir16
center_wavelength: 1.6137
- name: B12
common_name: swir22
center_wavelength: 2.2024
links:
- rel: self
href: http://cool-sat.com/collections/Sentinel-2
- rel: root
href: http://cool-sat.com/collections
- rel: license
href: >-
https://scihub.copernicus.eu/twiki/pub/SciHubWebPortal/TermsConditions/Sentinel_Data_Terms_and_Conditions.pdf
title: >-
Legal notice on the use of Copernicus Sentinel Data and Service Information
featureCollectionGeoJSON:
allOf:
- $ref: '#/components/schemas/schemas-featureCollectionGeoJSON'
- type: object
required:
- features
properties:
features:
type: array
items:
$ref: '#/components/schemas/item'
links:
$ref: '#/components/schemas/links'
timeStamp:
$ref: '#/components/schemas/timeStamp'
numberMatched:
$ref: '#/components/schemas/numberMatched'
numberReturned:
$ref: '#/components/schemas/numberReturned'
numberMatched:
description: |-
The number of features of the feature type that match the selection
parameters like `bbox`.
type: integer
minimum: 0
example: 127
numberReturned:
description: |-
The number of features in the feature collection.
A server may omit this information in a response, if the information
about the number of features is not known or difficult to compute.
If the value is provided, the value shall be identical to the number
of items in the "features" array.
type: integer
minimum: 0
example: 10
timeStamp:
description: >-
This property indicates the time and date when the response was generated.
type: string
format: date-time
example: 2017-08-17T08:05:32Z
pointGeoJSON:
type: object
required:
- type
- coordinates
properties:
type:
type: string
enum:
- Point
coordinates:
type: array
minItems: 2
items:
type: number
multipointGeoJSON:
type: object
required:
- type
- coordinates
properties:
type:
type: string
enum:
- MultiPoint
coordinates:
type: array
items:
type: array
minItems: 2
items:
type: number
linestringGeoJSON:
type: object
required:
- type
- coordinates
properties:
type:
type: string
enum:
- LineString
coordinates:
type: array
minItems: 2
items:
type: array
minItems: 2
items:
type: number
multilinestringGeoJSON:
type: object
required:
- type
- coordinates
properties:
type:
type: string
enum:
- MultiLineString
coordinates:
type: array
items:
type: array
minItems: 2
items:
type: array
minItems: 2
items:
type: number
polygonGeoJSON:
type: object
required:
- type
- coordinates
properties:
type:
type: string
enum:
- Polygon
coordinates:
type: array
items:
type: array
minItems: 4
items:
type: array
minItems: 2
items:
type: number
multipolygonGeoJSON:
type: object
required:
- type
- coordinates
properties: