-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathexample-openapi.yml
2416 lines (2369 loc) · 80.3 KB
/
example-openapi.yml
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: 'Building Blocks specified in OGC API - Moving Features - Part 1: Core'
version: 0.1.0
description: This is the OpenAPI definition of Moving Features API specification that conforms to the OGC Moving Features Encoding Extension - JSON.
contact:
name: OGC Moving Features SWG
email: moving-features.swg-bounces@lists.ogc.org
license:
name: OGC License
url: https://www.ogc.org/ogc/Document
x-logo:
url: https://www.ogc.org/pub/www/files/OGC_Logo_2D_Blue_x_0_0.png
backgroundColor: '#FFFFFF'
altText: OGC logo
href: https://www.ogc.org/contacts
tags:
- name: Capabilities
description: Essential characteristics of the information available from the API.
- name: MovingFeatureCollection
description: Collections of moving features to be logically managed by a user.
- name: MovingFeatures
description: Moving feature data, including the temporal geometry, temporal properties, etc.
- name: TemporalGeometry
description: The spatial change over time (temporal geometry), representing the movement of the rigid or nonrigid body of a feature.
- name: TemporalGeometryQuery
description: Queryable resources for the temporal primitive geometry.
- name: TemporalProperty
description: The thematic change over time (temporal property), representing the variation of the value of any descriptive characteristic of a feature.
paths:
/:
get:
operationId: getLandingPage
summary: Landing page
description: The landing page provides links to the API definition, the conformance statements and to the feature collections in this dataset.
tags:
- Capabilities
responses:
'200':
$ref: '#/components/responses/LandingPage'
'500':
$ref: '#/components/responses/ServerError'
/conformance:
get:
operationId: getConformance
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.
tags:
- Capabilities
responses:
'200':
$ref: '#/components/responses/Conformance'
'500':
$ref: '#/components/responses/ServerError'
/api:
get:
operationId: getAPIList
summary: API definition
description: A list of all API definition
tags:
- Capabilities
responses:
'500':
$ref: '#/components/responses/ServerError'
/collections:
get:
operationId: searchCatalog
summary: Retrieve catalogs of moving features collection
description: |
A user can retrieve catalogs to access collections by simple filtering and a limit.
tags:
- Capabilities
responses:
'200':
$ref: '#/components/responses/Collections'
'500':
$ref: '#/components/responses/ServerError'
post:
operationId: registerMetadata
summary: Register metadata about a collection of moving features
description: |
A user SHOULD register metadata about a collection of moving features into the system.
tags:
- MovingFeatureCollection
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/collection-2'
example:
title: moving_feature_collection_sample
updateFrequency: 1000
description: example
responses:
'201':
description: Successful create a collection to manage moving features.
headers:
Location:
description: A URI of the newly added resource
schema:
type: string
example: https://data.example.org/collections/mfc1
content:
application/json:
schema:
type: object
required:
- id
properties:
id:
type: string
description: Newly added resource ID
example:
id: mfc-1
'500':
$ref: '#/components/responses/ServerError'
/collections/{collectionId}:
get:
operationId: accessMetadata
summary: Access metadata about the collection
description: |
A user can access metadata with id `collectionId`.
tags:
- MovingFeatureCollection
parameters:
- $ref: '#/components/parameters/collectionId'
responses:
'200':
$ref: '#/components/responses/Collection'
'404':
description: A collection with the specified id was not found.
'500':
$ref: '#/components/responses/ServerError'
delete:
operationId: deleteCollection
summary: Delete the collection
description: |
The collection catalog with id `collectionId` and including metadata and moving features SHOULD be deleted.
tags:
- MovingFeatureCollection
parameters:
- $ref: '#/components/parameters/collectionId'
responses:
'204':
description: Successfully deleted.
'404':
description: A collection with the specified name was not found.
'500':
$ref: '#/components/responses/ServerError'
put:
operationId: replaceMetadata
summary: Replace metadata about the collection
description: |
A user SHOULD replace metadata with id `collectionId`.
The request body schema is the same the POST's one.
However, `updateFrequency` property is NOT updated.
tags:
- MovingFeatureCollection
parameters:
- $ref: '#/components/parameters/collectionId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/collection-2'
example:
title: moving_feature_collection_sample
updateFrequency: 1000
description: example
responses:
'204':
description: Successfully replaced.
'404':
description: A collection with the specified name was not found.
'500':
$ref: '#/components/responses/ServerError'
/collections/{collectionId}/items:
get:
operationId: retrieveMovingFeatures
summary: Retrieve moving feature collection
description: |
A user can retrieve moving feature collection to access the static information of the moving feature by simple filtering and a limit.
Specifically, if the `subTrajectory` parameter is "true", it will return the temporal geometry within the time interval specified by `datetime` parameter.
tags:
- MovingFeatures
parameters:
- $ref: '#/components/parameters/collectionId'
- $ref: '#/components/parameters/bbox'
- $ref: '#/components/parameters/datetime'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/subtrajectory-description'
responses:
'200':
$ref: '#/components/responses/MovingFeatures'
'404':
description: A collection with the specified id was not found.
'500':
$ref: '#/components/responses/ServerError'
post:
operationId: insertMovingFeatures
summary: Insert moving features
description: |
A user SHOULD insert a set of moving features or a moving feature into a collection with id `collectionId`.
The request body schema SHALL follows the [MovingFeature object](https://docs.opengeospatial.org/is/19-045r3/19-045r3.html#mfeature) or
[MovingFeatureCollection object](https://docs.opengeospatial.org/is/19-045r3/19-045r3.html#mfeaturecollection) in the OGC MF-JSON.
tags:
- MovingFeatures
parameters:
- $ref: '#/components/parameters/collectionId'
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/movingFeature-2'
- $ref: '#/components/schemas/movingFeatureCollection'
example:
type: Feature
crs:
type: Name
properties:
name: urn:ogc:def:crs:OGC:1.3:CRS84
trs:
type: Link
properties:
type: OGCDEF
href: http://www.opengis.net/def/uom/ISO-8601/0/Gregorian
temporalGeometry:
type: MovingPoint
datetimes:
- '2011-07-14T22:01:01Z'
- '2011-07-14T22:01:02Z'
- '2011-07-14T22:01:03Z'
- '2011-07-14T22:01:04Z'
- '2011-07-14T22:01:05Z'
coordinates:
- - 139.757083
- 35.627701
- 0.5
- - 139.757399
- 35.627701
- 2
- - 139.757555
- 35.627688
- 4
- - 139.757651
- 35.627596
- 4
- - 139.757716
- 35.627483
- 4
interpolation: Linear
base:
type: glTF
href: http://www.opengis.net/spec/movingfeatures/json/1.0/prism/example/car3dmodel.gltf
orientations:
- scales:
- 1
- 1
- 1
angles:
- 0
- 0
- 0
- scales:
- 1
- 1
- 1
angles:
- 0
- 355
- 0
- scales:
- 1
- 1
- 1
angles:
- 0
- 0
- 330
- scales:
- 1
- 1
- 1
angles:
- 0
- 0
- 300
- scales:
- 1
- 1
- 1
angles:
- 0
- 0
- 270
temporalProperties:
- datetimes:
- '2011-07-14T22:01:01.450Z'
- '2011-07-14T23:01:01.450Z'
- '2011-07-15T00:01:01.450Z'
length:
type: Measure
form: http://www.qudt.org/qudt/owl/1.0.0/quantity/Length
values:
- 1
- 2.4
- 1
interpolation: Linear
discharge:
type: Measure
form: MQS
values:
- 3
- 4
- 5
interpolation: Step
- datetimes:
- 1465621816590
- 1465711526300
camera:
type: Image
values:
- http://www.opengis.net/spec/movingfeatures/json/1.0/prism/example/image1
- iVBORw0KGgoAAAANSUhEU......
interpolation: Discrete
labels:
type: Text
values:
- car
- human
interpolation: Discrete
geometry:
type: LineString
coordinates:
- - 139.757083
- 35.627701
- 0.5
- - 139.757399
- 35.627701
- 2
- - 139.757555
- 35.627688
- 4
- - 139.757651
- 35.627596
- 4
- - 139.757716
- 35.627483
- 4
properties:
name: car1
state: test1
video: http://www.opengis.net/spec/movingfeatures/json/1.0/prism/example/video.mpeg
bbox:
- 139.757083
- 35.627483
- 0
- 139.757716
- 35.627701
- 4.5
time:
- '2011-07-14T22:01:01Z'
- '2011-07-15T01:11:22Z'
id: mf-1
responses:
'201':
description: |
Successful create a set of moving features or a moving feature into a specific collection.
headers:
Location:
description: A list of URI of the newly added resources
schema:
type: array
items:
type: string
example:
- https://data.example.org/collections/mfc-1/items/mf-1
- https://data.example.org/collections/mfc-1/items/109301273
'400':
description: A query parameter was not validly used.
'404':
description: A collection with the specified id was not found.
'500':
$ref: '#/components/responses/ServerError'
/collections/{collectionId}/items/{mFeatureId}:
get:
operationId: accessMovingFeature
summary: Access the static data of the moving feature
description: |
A user can access a static data of a moving feature with id `mFeatureId`.
The static data of a moving feature is not included temporal geometries and temporal properties.
tags:
- MovingFeatures
parameters:
- $ref: '#/components/parameters/collectionId'
- $ref: '#/components/parameters/mFeatureId'
responses:
'200':
$ref: '#/components/responses/MovingFeature'
'404':
description: |
- A collection with the specified id was not found.
- Or a moving feature with the specified id was not found.
'500':
$ref: '#/components/responses/ServerError'
delete:
operationId: deleteMovingFeature
summary: Delete a single moving feature
description: |
The moving feature with id `mFeatureId` and including temporal geometries and properties SHOULD be deleted.
tags:
- MovingFeatures
parameters:
- $ref: '#/components/parameters/collectionId'
- $ref: '#/components/parameters/mFeatureId'
responses:
'204':
description: Successfully deleted.
'404':
description: |
- A collection with the specified id was not found.
- Or a moving feature with the specified id was not found.
'500':
$ref: '#/components/responses/ServerError'
/collections/{collectionId}/items/{mFeatureId}/tgsequence:
get:
operationId: retrieveTemporalGeometrySequence
summary: Retrieve the movement data of the single moving feature
description: |
A user can retrieve only the movement data of a moving feature with id `mFeatureId` by simple filtering and a limit.
tags:
- TemporalGeometry
parameters:
- $ref: '#/components/parameters/collectionId'
- $ref: '#/components/parameters/mFeatureId'
- $ref: '#/components/parameters/bbox'
- $ref: '#/components/parameters/datetime'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/leaf-description'
- $ref: '#/components/parameters/subtrajectory-description'
responses:
'200':
$ref: '#/components/responses/TemporalGeometrySequence'
'500':
$ref: '#/components/responses/ServerError'
post:
operationId: insertTemporalPrimitiveGeometry
summary: Add movement data into the moving feature
description: |
A user SHOULD add more movement data into a moving feature with id `mFeatureId`.
The request body schema SHALL follows the [TemporalPrimitiveGeometry object](https://docs.ogc.org/is/19-045r3/19-045r3.html#tprimitive) in the OGC MF-JSON.
tags:
- TemporalGeometry
parameters:
- $ref: '#/components/parameters/collectionId'
- $ref: '#/components/parameters/mFeatureId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/temporalPrimitiveGeometry'
example:
type: MovingPoint
datetimes:
- '2011-07-14T22:01:06Z'
- '2011-07-14T22:01:07Z'
- '2011-07-14T22:01:08Z'
- '2011-07-14T22:01:09Z'
- '2011-07-14T22:01:10Z'
coordinates:
- - 139.757083
- 35.627701
- 0.5
- - 139.757399
- 35.627701
- 2
- - 139.757555
- 35.627688
- 4
- - 139.757651
- 35.627596
- 4
- - 139.757716
- 35.627483
- 4
interpolation: Linear
base:
type: glTF
href: https://www.opengis.net/spec/movingfeatures/json/1.0/prism/example/car3dmodel.gltf
orientations:
- scales:
- 1
- 1
- 1
angles:
- 0
- 0
- 0
- scales:
- 1
- 1
- 1
angles:
- 0
- 355
- 0
- scales:
- 1
- 1
- 1
angles:
- 0
- 0
- 330
- scales:
- 1
- 1
- 1
angles:
- 0
- 0
- 300
- scales:
- 1
- 1
- 1
angles:
- 0
- 0
- 270
responses:
'201':
description: |
Successful add more movement data into a specified moving feature.
headers:
Location:
description: A URI of the newly added resource
schema:
type: string
example: https://data.example.org/collections/mfc-1/items/mf-1/tgsequence/tg-2
'400':
description: A query parameter was not validly used.
'404':
description: |
- A collection with the specified id was not found.
- Or a moving feature with the specified id was not found.
'500':
$ref: '#/components/responses/ServerError'
/collections/{collectionId}/items/{mFeatureId}/tgsequence/{tGeometryId}:
delete:
operationId: deleteTemporalPrimitiveGeometry
summary: Delete a singe temporal primitive geometry
description: |
The temporal primitive geometry with id `tGeometryId` SHOULD be deleted.
tags:
- TemporalGeometry
parameters:
- $ref: '#/components/parameters/collectionId'
- $ref: '#/components/parameters/mFeatureId'
- $ref: '#/components/parameters/tGeometryId'
responses:
'204':
description: Successfully deleted.
'404':
description: |
- A collection with the specified id was not found.
- Or a moving feature with the specified id was not found.
- Or a temporal primitive geometry with the specified id was not found.
'500':
$ref: '#/components/responses/ServerError'
/collections/{collectionId}/items/{mFeatureId}/tgsequence/{tGeometryId}/distance:
get:
operationId: getDistanceOfTemporalPrimitiveGeometry
summary: Get a time-to-distance curve of a temporal primitive geometry
description: |
A user can get time-to-distance curve of a temporal primitive geometry with id `tGeometryId`.
When `date-time` query parameter is provided, this operation will return a single distance value according to the specified date and time in the `data-time` parameter.
tags:
- TemporalGeometryQuery
parameters:
- $ref: '#/components/parameters/collectionId'
- $ref: '#/components/parameters/mFeatureId'
- $ref: '#/components/parameters/tGeometryId'
- $ref: '#/components/parameters/date-time'
responses:
'200':
$ref: '#/components/responses/DistanceQuery'
'400':
description: A query parameter was not validly used.
'500':
$ref: '#/components/responses/ServerError'
/collections/{collectionId}/items/{mFeatureId}/tgsequence/{tGeometryId}/velocity:
get:
operationId: getVelocityOfTemporalPrimitiveGeometry
summary: Get a time-to-velocity curve of a temporal primitive geometry
description: |
A user can get time-to-velocity curve of a temporal primitive geometry with id `tGeometryId`.
When `date-time` query parameter is provided, this operation will return a single velocity value according to the specified date and time in the `data-time` parameter.
tags:
- TemporalGeometryQuery
parameters:
- $ref: '#/components/parameters/collectionId'
- $ref: '#/components/parameters/mFeatureId'
- $ref: '#/components/parameters/tGeometryId'
- $ref: '#/components/parameters/date-time'
responses:
'200':
$ref: '#/components/responses/VelocityQuery'
'400':
description: A query parameter was not validly used.
'500':
$ref: '#/components/responses/ServerError'
/collections/{collectionId}/items/{mFeatureId}/tgsequence/{tGeometryId}/acceleration:
get:
operationId: getAccelerationOfTemporalPrimitiveGeometry
summary: Get a time-to-acceleration curve of a temporal primitive geometry
description: |
A user can get time-to-acceleration curve of a temporal primitive geometry with id `tGeometryId`.
When `date-time` query parameter is provided, this operation will return a single acceleration value according to the specified date and time in the `data-time` parameter.
tags:
- TemporalGeometryQuery
parameters:
- $ref: '#/components/parameters/collectionId'
- $ref: '#/components/parameters/mFeatureId'
- $ref: '#/components/parameters/tGeometryId'
- $ref: '#/components/parameters/date-time'
responses:
'200':
$ref: '#/components/responses/AccelerationQuery'
'400':
description: A query parameter was not validly used.
'500':
$ref: '#/components/responses/ServerError'
/collections/{collectionId}/items/{mFeatureId}/tproperties:
get:
operationId: retrieveTemporalProperties
summary: Retrieve a set of the temporal property data
description: |
A user can retrieve the static information of the temporal property data that included a single moving feature with id `mFeatureId`.
The static data of a temporal property is not included temporal values (property `valueSequence`).
Also a user can retrieve the sub sequence of the temporal information of the temporal property data for the specified time interval with `subTemporalValue` query parameter.
In this case, `temporalProperties` property schema SHALL follows the [TemporalProperties object](https://docs.ogc.org/is/19-045r3/19-045r3.html#tproperties) in the OGC MF-JSON.
tags:
- TemporalProperty
parameters:
- $ref: '#/components/parameters/collectionId'
- $ref: '#/components/parameters/mFeatureId'
- $ref: '#/components/parameters/datetime'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/subtemporalvalue-description'
responses:
'200':
$ref: '#/components/responses/TemporalProperties'
'400':
description: A query parameter was not validly used.
'500':
$ref: '#/components/responses/ServerError'
post:
operationId: insertTemporalProperty
summary: Add temporal property data
description: |
A user SHOULD add new temporal property data into a moving feature with id `mFeatureId`.
The request body schema SHALL follows the [TemporalProperties object](https://docs.opengeospatial.org/is/19-045r3/19-045r3.html#tproperties) in the OGC MF-JSON.
tags:
- TemporalProperty
parameters:
- $ref: '#/components/parameters/collectionId'
- $ref: '#/components/parameters/mFeatureId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/temporalProperties'
example:
- datetimes:
- '2011-07-14T22:01:01.450Z'
- '2011-07-14T23:01:01.450Z'
- '2011-07-15T00:01:01.450Z'
length:
type: Measure
form: http://www.qudt.org/qudt/owl/1.0.0/quantity/Length
values:
- 1
- 2.4
- 1
interpolation: Linear
discharge:
type: Measure
form: MQS
values:
- 3
- 4
- 5
interpolation: Step
- datetimes:
- '2011-07-14T22:01:01.450Z'
- '2011-07-14T23:01:01.450Z'
camera:
type: Image
values:
- http://www.opengis.net/spec/movingfeatures/json/1.0/prism/example/image1
- iVBORw0KGgoAAAANSUhEU......
interpolation: Discrete
labels:
type: Text
values:
- car
- human
interpolation: Discrete
responses:
'201':
description: |
Successful add more temporal property into a specified moving feature.
headers:
Locations:
description: A list of URI of the newly added resources
schema:
type: array
items:
type: string
example:
- https://data.example.org/collections/mfc-1/items/mf-1/tproperties/length
- https://data.example.org/collections/mfc-1/items/mf-1/tproperties/discharge
- https://data.example.org/collections/mfc-1/items/mf-1/tproperties/camera
- https://data.example.org/collections/mfc-1/items/mf-1/tproperties/labels
'404':
description: |
- A collection with the specified id was not found.
- Or a moving feature with the specified id was not found.
'500':
$ref: '#/components/responses/ServerError'
/collections/{collectionId}/items/{mFeatureId}/tproperties/{tPropertyName}:
get:
operationId: retrieveTemporalProperty
summary: Retrieve a temporal property
description: |
A user can retrieve only the temporal values with a specified name `tPropertyName` of temporal property.
tags:
- TemporalProperty
parameters:
- $ref: '#/components/parameters/collectionId'
- $ref: '#/components/parameters/mFeatureId'
- $ref: '#/components/parameters/tPropertyName'
- $ref: '#/components/parameters/datetime'
- $ref: '#/components/parameters/leaf-description'
- $ref: '#/components/parameters/subtemporalvalue-description'
responses:
'200':
$ref: '#/components/responses/TemporalProperty'
'400':
description: A query parameter was not validly used.
'500':
$ref: '#/components/responses/ServerError'
post:
operationId: insertTemporalPrimitiveValue
summary: Add temporal primitive value data
description: |
A user SHOULD add more temporal primitive value data into a temporal property with id `tPropertyName`.
tags:
- TemporalProperty
parameters:
- $ref: '#/components/parameters/collectionId'
- $ref: '#/components/parameters/mFeatureId'
- $ref: '#/components/parameters/tPropertyName'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/temporalPrimitiveValue'
example:
datetimes:
- '2011-07-15T08:00:00Z'
- '2011-07-15T08:00:01Z'
- '2011-07-15T08:00:02Z'
values:
- 0
- 20
- 50
interpolation: Linear
responses:
'201':
description: |
Successful add more temporal primitive value data into a specified temporal property.
'404':
description: |
- A collection with the specified id was not found.
- Or a moving feature with the specified id was not found.
- Or a temporal property with the specified id was not found.
'500':
$ref: '#/components/responses/ServerError'
delete:
operationId: deleteTemporalProperty
summary: Delete a specified temporal property
description: |
The temporal property with id `tPropertyName` SHOULD be deleted.
tags:
- TemporalProperty
parameters:
- $ref: '#/components/parameters/collectionId'
- $ref: '#/components/parameters/mFeatureId'
- $ref: '#/components/parameters/tPropertyName'
responses:
'204':
description: Successfully deleted.
'404':
description: |
- A collection with the specified id was not found.
- Or a moving feature with the specified id was not found.
- Or a temporal property with the specified id was not found.
'500':
$ref: '#/components/responses/ServerError'
components:
schemas:
link:
type: object
required:
- href
- rel
properties:
href:
type: string
example: http://data.example.com/buildings/123
rel:
type: string
example: alternate
type:
type: string
example: application/geo+json
hreflang:
type: string
example: en
title:
type: string
example: Trierer Strasse 70, 53115 Bonn
length:
type: integer
landingPage:
type: object
required:
- links
properties:
title:
type: string
example: Moving features data server
description:
type: string
example: Access to data about moving features
links:
type: array
items:
$ref: '#/components/schemas/link'
exception:
type: object
required:
- code
properties:
code:
type: string
description:
type: string
confClasses:
type: object
required:
- conformsTo
properties:
conformsTo:
type: array
items:
type: string
example:
- http://www.opengis.net/spec/ogcapi-movingfeatures-1/1.0/conf/common
- http://www.opengis.net/spec/ogcapi-movingfeatures-1/1.0/conf/mf-collection
- http://www.opengis.net/spec/ogcapi-movingfeatures-1/1.0/conf/movingfeatures
extent:
description: |-
The extent of the features in the collection. In the Core only spatial and temporal
extents are specified. Extensions may add additional members to represent other
extents, for example, thermal or pressure ranges.
An array of extents is provided for each extent type (spatial, temporal). The first item
in the array describes the overall extent of the data. All subsequent items describe more
precise extents, e.g., to identify clusters of data. Clients only interested in the
overall extent will only need to access the first extent in the array.
type: object
properties:
spatial:
description: The spatial extent of the features in the collection.
type: object
properties:
bbox:
description: |-
One or more bounding boxes that describe the spatial extent of the dataset.
In the Core only a single bounding box is supported.
Extensions may support additional areas.
The first bounding box describes the overall spatial
extent of the data. All subsequent bounding boxes describe
more precise bounding boxes, e.g., to identify clusters of data.
Clients only interested in the overall spatial extent will
only need to access the first bounding box in the 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)
If the value consists of four numbers, the coordinate reference system 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`.
If the value consists of six numbers, the coordinate reference system is WGS 84
longitude/latitude/ellipsoidal height (http://www.opengis.net/def/crs/OGC/0/CRS84h)
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
oneOf:
- minItems: 4
maxItems: 4
- minItems: 6
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 the only other supported coordinate reference system is
WGS 84 longitude/latitude/ellipsoidal height for coordinates with height.
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
- http://www.opengis.net/def/crs/OGC/0/CRS84h
default: http://www.opengis.net/def/crs/OGC/1.3/CRS84
temporal:
description: The temporal extent of the features in the collection.
type: object
properties:
interval:
description: |-
One or more time intervals that describe the temporal extent of the dataset.
In the Core only a single time interval is supported.
Extensions may support multiple intervals.
The first time interval describes the overall
temporal extent of the data. All subsequent time intervals describe
more precise time intervals, e.g., to identify clusters of data.
Clients only interested in the overall temporal extent will only need
to access the first time interval in the array (a pair of lower and upper
bound instants).
type: array
minItems: 1
items:
description: |-
Begin and end times of the time interval. The timestamps are in the
temporal coordinate reference system specified in `trs`. By default
this is the Gregorian calendar.
The value `null` at start or end is supported and indicates a half-bounded interval.
type: array
minItems: 2