-
Notifications
You must be signed in to change notification settings - Fork 7
/
api-docs.yaml
1395 lines (1393 loc) · 45.6 KB
/
api-docs.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.0
info:
title: Measur3D
version: 0.3.0
description: A light and compact CityJSON management tool
license:
name: Apache-2.0
url: 'https://www.apache.org/licenses/LICENSE-2.0'
contact:
name: Gilles-Antoine Nys
email: [email protected]
servers:
- url: 'http://localhost:3001/measur3d'
description: Measur3D RESTful API
- url: 'http://localhost:3001/features'
description: OGC API - Features
tags:
- Measur3D
- Features
paths:
/api-docs:
get:
summary: Get the full API documentation.
description: The documentation can be queried in YAML or JSON format.
tags:
- Measur3D
parameters:
- in: query
name: f
schema:
type: string
enum:
- YAML
- json
default: json
responses:
'201':
description: Full documentation of the APIs Measur3D and Features.
/uploadCityModel:
post:
summary: Uploads a CityModel.
description: >-
This function allows to upload a CityJSON file (v 1.0.x). The file will
be processed in order to distribute the information in the different
documents in the database following the CityModel, AbstractCityObject
and Geometry schemas (other schemas will be supported in further
developments).
tags:
- Measur3D
parameters:
- name: jsonName
description: >-
Name of the CityModel - name of the file in the Measur3D
application.
in: body
required: true
type: string
- name: content
description: The content of the JSON file as a JSON object.
in: body
required: true
type: object
schema:
$ref: '#/components/schemas/CityModel'
responses:
'201':
description: Created - upload of the CityJSON file successful.
content:
application/json:
schema:
type: object
properties:
success:
type: string
default: File uploaded
example:
success: File uploaded
'408':
description: >-
Request timeout - took over 10 minutes (Uploading a CityModel can be
very long).
/getCityModelsList:
get:
summary: Get list of available CityModels.
description: >-
Concurrent models can be stored in the database. This function allows
describing these models providing summary information.
tags:
- Measur3D
responses:
'200':
description: OK - returns.
content:
application/json:
schema:
type: array
items:
type: object
properties:
name:
type: string
nbr_el:
type: number
filesize:
type: string
example:
- name: model_1
nbr_el: 845
filesize: 1.24Mb
- name: model_2
nbr_el: 642
filesize: 835.1Kb
'404':
description: Not found - There is no CityModel in the database.
/getNamedCityModel:
get:
summary: Get a specific CityModel.
description: >-
This function allows getting a specific CityModel. It gathers all
information related to the model in the different collections from the
database.
tags:
- Measur3D
parameters:
- name: name
description: >-
Name of the CityModel - name of the file in the Measur3D
application.
in: body
required: true
type: string
responses:
'200':
description: OK - returns a '#/CityModel'.
content:
application/json:
schema:
$ref: '#/components/schemas/CityModel'
'500':
description: Not found - There is no CityModel in the database.
/deleteNamedCityModel:
delete:
summary: Delete a specific CityModel.
description: >-
This function allows deleting a specific CityModel. It deletes all
information related to the model in the different collections from the
database.
tags:
- Measur3D
responses:
'200':
description: OK - returns a JSON success.
content:
application/json:
schema:
type: object
properties:
success:
type: string
default: City model deleted with success !
example:
success: City model deleted with success !
'404':
description: Not found - There is no document with that name.
/getObject:
get:
summary: Get a specific CityObject.
description: >-
This function allows getting a specific CityObject. It gathers the
object and its highest lod geometry.
tags:
- Measur3D
parameters:
- name: name
description: Name of the object.
in: body
type: string
- name: id
description: Id of the object.
in: body
type: string
- name: CityObjectType
description: Type of the object.
in: body
required: true
type: string
responses:
'200':
description: OK - returns a '#/AbstractCityObject'.
content:
application/json:
schema:
$ref: '#/components/schemas/AbstractCityObject'
'400':
description: Bad request - Params are not valid.
type: object
properties:
error:
type: string
default: Params are not valid.
'500':
description: >-
Internal error - getObject could not find Object in Collection.
Error is sent by database.
/deleteObject:
delete:
summary: Delete a specific CityObject.
description: >-
This function allows deleting a specific CityObject. It deletes an
object and all its related geometries.
tags:
- Measur3D
responses:
'200':
description: OK - returns a JSON success.
content:
application/json:
schema:
type: object
properties:
success:
type: string
default: City model deleted with success !
example:
success: Object and children deleted !
'500':
description: Something went bad - error generated by the database.
/getObjectAttributes:
get:
summary: Get the attributes of a specific CityObject.
description: >-
This function allows getting the attributes of a specific CityObject. It
gathers the object attributes in order to render in the
AttributesManager Component.
tags:
- Measur3D
parameters:
- name: name
description: Name of the object.
in: body
type: string
- name: id
description: Id of the object.
in: body
type: string
- name: CityObjectType
description: Type of the object.
in: body
required: true
type: string
responses:
'200':
description: OK - returns an array of all the '#/AbstractCityObject.attributes'.
content:
application/json:
schema:
type: array
items:
type: object
example: Key/Value pairs
'400':
description: Bad request - Params are not valid.
type: object
properties:
error:
type: string
default: Params are not valid.
'500':
description: >-
Internal error - getObjectAttributes could not find Object in
Collection. Error is sent by database.
/updateObjectAttribute:
put:
summary: Update/delete an attribute of a specific CityObject.
description: >-
This function allows updating or deleting a key/value pair in the
attributes of a specific CityObject. It corresponds to a modification of
a line in the AttributesManager Component. If a new key or value is
given, the pair is updated. If a value is not given, the old key is
deleted from the document. If a new key is given, the key/value pair is
created within the document.
tags:
- Measur3D
parameters:
- name: jsonName
description: Name of the object.
in: body
type: string
- name: CityObjectType
description: Type of the object.
in: body
required: true
type: string
- name: key
description: The new key.
in: body
required: true
type: string
- name: old_key
description: The old key.
in: body
type: string
- name: value
description: The value (can be empty).
in: body
required: true
type: string
responses:
'200':
description: OK - returns a success message in a JSON object.
content:
application/json:
schema:
type: object
properties:
success:
type: string
default: Object updated.
example: Key/Value pairs
'400':
description: Bad request - Params are not valid.
type: object
properties:
error:
type: string
default: Params are not valid.
'500':
description: >-
Internal error - updateObjectAttribute could not find Object in
Collection. Error is sent by database.
/:
get:
summary: Access to the landing page.
description: Information can be accessed in HTML or JSON formats.
tags:
- Features
responses:
'200':
description: Returns the landing page of the API.
content:
application/json:
schema:
type: object
required:
- links
properties:
title:
type: string
description:
type: string
links:
type: array
items:
$ref: >-
http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/link.yaml
'400':
description: Returns an error due to format.
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
example: InvalidParameterValue
description:
type: string
example: Invalid format
/conformance:
get:
summary: Access to the conformance page.
description: >-
To support "generic" clients that want to access multiple OGC API
Features implementations - and not "just" a specific API / server, the
server has to declare the conformance classes it implements and conforms
to.
tags:
- Features
responses:
'200':
description: Returns the conformance array.
content:
application/json:
schema:
type: object
required:
- conformsTo
properties:
conformsTo:
type: array
items:
type: string
/api:
get:
summary: Get the full API documentation.
description: The documentation can be queried in YAML or JSON format.
tags:
- Features
parameters:
- in: query
name: f
schema:
type: string
enum:
- YAML
- json
default: json
responses:
'201':
description: Full documentation of the APIs Measur3D and Features.
'308':
description: Redirect to .html.
'400':
description: Returns an error due to format.
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
example: InvalidParameterValue
description:
type: string
example: Invalid format
/api.html:
get:
summary: Get the API documentation as HTML.
description: >-
NOT AVAILABLE - This function allows getting a specific CityModel. It
gathers all information related to the model in the different
collections from the database.
tags:
- Features
/collections:
get:
summary: Access to the collections page - About page.
description: Information can be accessed in HTML or JSON formats.
tags:
- Features
parameters:
- in: query
name: f
schema:
type: string
enum:
- HTML
- json
default: HTML
responses:
'200':
description: Returns an about page on collections.
content:
application/json:
schema:
type: object
required:
- links
- collections
properties:
links:
type: array
items:
$ref: >-
http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/link.yaml
collections:
type: array
items:
$ref: >-
http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/collection.yaml
'400':
description: Returns an error due to format.
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
example: InvalidParameterValue
description:
type: string
example: Invalid format
'404':
description: There is no collections in the database.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: There is no collection in the database.
'/collections/:collectionId':
get:
summary: Get a specific collection.
description: >-
This function allows getting a specific CityModel. It gathers all
information related to the model in the different collections from the
database.
tags:
- Features
parameters:
- in: query
name: f
schema:
type: string
enum:
- HTML
- json
default: HTML
- in: path
name: collectionId
schema:
type: string
responses:
'200':
description: Returns a collection of features and its metadata.
content:
application/json:
schema:
type: object
$ref: >-
http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/collection.yaml
'400':
description: Returns an error due to format.
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
example: InvalidParameterValue
description:
type: string
example: Invalid format
'404':
description: There is no collections in the database.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: There is no collection in the database.
'/collections/:collectionId/items':
get:
summary: Get items of a specific collection.
description: >-
This function allows getting all the items of a specific collection
(limited to 10 items by default).
tags:
- Features
parameters:
- in: query
name: f
schema:
type: string
enum:
- HTML
- json
default: HTML
style: form
explode: false
required: false
- in: query
name: limit
schema:
type: integer
minimum: 1
maximum: 10000
default: 10
style: form
explode: false
required: false
- in: query
name: offset
schema:
type: integer
default: 0
style: form
explode: false
required: false
- in: query
name: bbox
schema:
type: array
minItems: 4
maxItems: 6
items:
type: number
style: form
explode: false
required: false
- in: query
name: datetime
schema:
type: string
style: form
explode: false
required: false
- in: query
name: any
description: >-
a feature property that has a simple value (for example, a string or
integer) that is expected to be useful for applications using the
service to filter the features of the collection based on this
property, a parameter with the name of the feature property.
schema:
type: string
style: form
explode: false
required: false
- in: path
name: collectionId
schema:
type: string
responses:
'200':
description: >-
Returns a CityModel formalised following the OGC API Features - Part
1.
content:
application/json:
schema:
type: object
required:
- id
- links
properties:
id:
description: 'identifier of the collection used, for example, in URIs'
type: string
title:
description: human readable title of the collection
type: string
description:
description: a description of the features in the collection
type: string
links:
type: array
items:
$ref: >-
http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/link.yaml
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.
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. If multiple areas are
provided, the union of the bounding boxes
describes the spatial extent.
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
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
properties:
interval:
description: >-
One or more time intervals that describe the
temporal extent of the dataset. The value `null`
is supported and indicates an open time intervall.
In the Core only a single time interval is
supported. Extensions may support multiple
intervals. If multiple intervals are provided, the
union of the intervals describes the temporal
extent.
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.
type: array
minItems: 2
maxItems: 2
items:
type: string
format: date-time
nullable: true
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
itemType:
description: >-
indicator about the type of the items in the collection
(the default value is 'feature').
type: string
default: feature
crs:
description: >-
the list of coordinate reference systems supported by the
service
type: array
items:
type: string
default:
- 'http://www.opengis.net/def/crs/OGC/1.3/CRS84'
'400':
description: Returns an error due to format. Refer the erroneous parameter.
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
example: InvalidParameterValue
description:
type: string
example: 'Invalid # format'
'404':
description: There is no item in the database.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: There is no item in this collection.
'500':
description: There is no item in the database.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: There is no item in the database.
'/collections/:collectionId/items/:item':
get:
summary: Get a specific CityObject.
description: >-
This function allows getting a specific CityObject. It gathers all
information related to the object in the different collections from the
database.
tags:
- Features
parameters:
- in: query
name: f
schema:
type: string
enum:
- HTML
- json
default: HTML
- in: path
name: collectionId
schema:
type: string
- in: path
name: item
schema:
type: string
responses:
'200':
description: OK - returns a '#/AbstractCityObject'.
content:
application/json:
schema:
$ref: '#/components/schemas/AbstractCityObject'
'400':
description: Returns an error due to format.
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
example: InvalidParameterValue
description:
type: string
example: Invalid format
'404':
description: This item does not exist in this collection.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: This item does not exist in this collection.
components:
schemas:
CityModel:
type: object
required:
- name
- type
- version
- CityObjects
- vertices
properties:
name:
type: string
description: >-
Unique name of the CityModel (not its UUID) - created by the method
'#/Measur3D/uploadCityModel'. Basically the name of the uploaded
file.
type:
type: string
default: CityJSON
description: Imposed.
version:
type: string
description: >-
A string with the version (X.Y) of CityJSON used. Minor versions are
not considered.
CityObjects:
type: object
properties:
'#/AbstractCityObject/name':
type: object
properties:
id:
type: string
description: UUID id of the document in the database.
type:
type: string
description: Type of the CityObject.
description: >-
A collection of key-value pairs, where the key is the name of the
CityObject, and the value is couple of key giving the object id and
its type.
vertices:
type: array
items:
type: string
description: >-
Remains of the initial CityJSON specs. Vertices are now stored in
'#/AbstractCityObject'. Should be empty.
extension:
type: object
properties:
url:
type: string
format: URL
description: External link to the ressource.
version:
type: string
description: Version of the extension.
description: >-
A JSON file that allows us to document how the core data model of
CityJSON may be extended, and to validate CityJSON files.
metadata:
type: object
properties:
filesize:
type: number
description: >-
Size of the CityJSON file in bits - created by the method
'#/Measur3D/uploadCityModel'.
nbr_el:
type: number
descrption: Number of AbstractCityObject in the CityModel.
geographicalExtent:
type: array
items:
type: number
description: 'An array with 6 values - [minx, miny, minz, maxx, maxy, maxz].'
spatialIndex:
type: boolean
description: A boolean specifiying if the object is spatially indexed or not.
location:
type: object
properties:
type:
type: string
default:
- Polygon
coordinates:
type: string
format: ISO19107
description: >-
A hierarchy of arrays following the ISO19107 standard. Duplicate
information of the '#/geographicalExtent'. Useful in order to
index objects spatialy.
referenceSystem:
type: string
format: OGC CRS URN
description: >-
A string that defines a coordinate reference system. Note that
all CityObjects need to have the same CRS.
contactDetails:
type: object
properties:
contactName:
type: string
phone:
type: string
address:
type: string
emailAddress:
type: string
contactType:
type: string
enums: