-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger-draft.yaml
1553 lines (1552 loc) · 42.7 KB
/
swagger-draft.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.1
info:
title: API Factory - Object Stream API
description: Object Stream API
termsOfService: https://datahub.mksmart.org
contact:
email: [email protected]
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: 0.9.4
tags:
- name: browse
description: Browse a dataset, with full control over filters, pagination, sorting
- name: object
description: Create, retrieve, update and delete JSON documents
- name: file
description: Create, retrieve, update and delete files
- name: license
description: Create, retrieve, set and update licenses
- name: changes
description: Monitoring changes
- name: schemas
description: Retrieve a schema
- name: sparql
description: Perform a SPARQL query against the data
paths:
/browse/{dataset-uuid}:
get:
tags:
- browse
summary: Retrieve documents from the dataset
operationId: browseDocuments
parameters:
- name: dataset-uuid
in: path
description: dataset uuid identifier
required: true
schema:
type: string
- name: query
in: query
description: The filter query
required: false
schema:
type: string
- name: sort
in: query
description: Optionally specify fields on which to sort the data. Sort fields should be specified as a comma separated list. Data will be sorted in ascending order. To specify a field to sort in descending order precede that field with a minus ('-')
schema:
type: string
- name: fields
in: query
description: Optionally specify which fields to return. Fields should be specified as a comma separated list. Fields preceded with a minus ("-") will be excluded from the results. The "_id" field is always returned, unless explicitly excluded.
schema:
type: string
- name: pagesize
in: query
description: Optionally specify page size (defaults to a page size of 100)
schema:
minimum: 0
type: integer
- name: page
in: query
description: Optionally specify the page number of results to return (defaults to page 1)
schema:
minimum: 0
type: integer
responses:
'200':
description: Success
'400':
description: Bad request, malformed JSON
'500':
description: Fatal error creating object
/object/{dataset-uuid}:
get:
tags:
- object
summary: Retrieve documents from the dataset
operationId: getDocuments
parameters:
- name: dataset-uuid
in: path
description: dataset uuid identifier
required: true
schema:
type: string
- name: query
in: query
description: The filter query
required: false
schema:
type: string
- name: limit
in: query
description: Optionally limit the number of documents returned
schema:
minimum: 0
type: integer
responses:
'200':
description: Success
'400':
description: Bad request, malformed JSON
'500':
description: Fatal error creating object
post:
tags:
- object
summary: Create a new document in the dataset
operationId: createDocument
parameters:
- name: dataset-uuid
in: path
description: dataset uuid identifier
required: true
schema:
type: string
requestBody:
description: The document to be created
content:
application/json:
schema:
type: object
example:
_id: '1067'
sensorID: 42-a
sensorValue: 34.7
required: true
responses:
'201':
description: Object created
'400':
description: Bad request, malformed JSON
'500':
description: Fatal error creating object
/object/{dataset-uuid}/{doc_id}:
get:
tags:
- object
summary: Retrieve a single document from the dataset
operationId: getDocument
parameters:
- name: dataset-uuid
in: path
description: dataset uuid identifier
required: true
schema:
type: string
- name: doc_id
in: path
required: true
schema:
type: string
- name: limit
in: query
description: Optionally limit the number of documents returned
schema:
minimum: 0
type: integer
responses:
'200':
description: Success
'400':
description: Bad request, malformed JSON
'500':
description: Fatal error creating object
put:
tags:
- object
summary: Update a document by ID
description: Update an existing document, referenced by ID. Note that the existing document will be overwritten, so a full document should be supplied.
operationId: updateDocumentById
parameters:
- name: dataset-uuid
in: path
description: The UUID of the dataset
required: true
schema:
type: string
- name: doc_id
in: path
required: true
schema:
type: string
requestBody:
description: The updated document
content:
application/json:
schema:
type: object
required: true
responses:
'201':
description: Object creted
'204':
description: Object updated
'500':
description: Fatal error creating or updating object
delete:
tags:
- object
summary: Delete a document by ID
description: Delete an existing document, referenced by ID.
operationId: deleteDocumentById
parameters:
- name: dataset-uuid
in: path
description: The UUID of the dataset
required: true
schema:
type: string
- name: doc_id
in: path
required: true
schema:
type: string
responses:
'200':
description: No items to delete
'204':
description: Object deleted
'500':
description: Fatal error deleting object
/file/{dataset-id}:
get:
tags:
- file
summary: Retrieve a list of files for a single dataset
operationId: getFiles
parameters:
- name: dataset-id
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
post:
tags:
- file
summary: Upload a new file
operationId: createFile
parameters:
- name: dataset-id
in: path
required: true
schema:
type: string
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
title:
type: string
description:
type: string
file:
type: string
format: binary
responses:
'201':
description: File uploaded
/file/{dataset-id}/{filename}:
get:
tags:
- file
summary: Retrieve a single file
operationId: getFile
parameters:
- name: dataset-id
in: path
required: true
schema:
type: string
- name: filename
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
post:
tags:
- file
summary: Update an existing file
description: Overwrite/update an existing file and correspoinding title and description. Note that the uploaded filename must match the original filename that is being overwritten.
operationId: updateFile
parameters:
- name: dataset-id
in: path
required: true
schema:
type: string
- name: filename
description: The existing filename to be updated
in: path
required: true
schema:
type: string
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
title:
type: string
description:
type: string
file:
type: string
format: binary
responses:
'204':
description: File updated
delete:
tags:
- file
summary: Delete a file
operationId: deleteFile
parameters:
- name: dataset-id
in: path
required: true
schema:
type: string
- name: filename
in: path
required: true
schema:
type: string
responses:
'204':
description: File deleted
/license:
get:
tags:
- license
summary: Retrieve catalogue of licenses
operationId: getLicenses
parameters:
- name: sort
in: query
description: Optionally reverse the sort order to retrieve items oldest-first
required: false
schema:
type: integer
enum:
- 1
responses:
'200':
description: Success
post:
tags:
- license
summary: Create a new license
description: Upload a new license to the catalogue
operationId: createLicense
requestBody:
description: The license
content:
application/json:
schema:
type: object
required: true
responses:
'201':
description: License created
/license/{license-id}:
get:
tags:
- license
summary: Retrieve a single license
operationId: getLicense
parameters:
- name: license-id
in: path
description: License ID
required: true
schema:
type: string
- name: sort
in: query
description: Optionally reverse the sort order to retrieve items oldest-first
required: false
schema:
type: integer
enum:
- 1
responses:
'200':
description: Success
put:
tags:
- license
summary: Update a license
description: Update an existing license by id
operationId: updateLicense
requestBody:
description: The license
content:
application/json:
schema:
type: object
required: true
responses:
'204':
description: License updated
/license/dataset/{dataset-id}:
get:
tags:
- license
summary: Retrieve license information for a dataset
operationId: getDatasetLicense
parameters:
- name: dataset-id
in: path
description: Dataset ID
required: true
schema:
type: string
- name: detail
in: query
required: false
schema:
type: string
enum: [summary, full]
description: >
Detail level:
`summary` - Top level dataset license summary
`full` - Full hierarchy of sub policies including for all documents and files where applicable
responses:
'200':
description: Success
post:
tags:
- license
summary: Assign license information for a dataset
description: Assign a new license to a dataset. Note that if this dataset already has license information attached, the license update function (PUT) should be used instead.
operationId: createDatasetLicense
parameters:
- name: dataset-id
in: path
description: Dataset ID
required: true
schema:
type: string
requestBody:
description: The license
content:
application/json:
schema:
type: object
required: true
responses:
'201':
description: Dataset license added
put:
tags:
- license
summary: Update license information for a dataset
description: Update an existing license for a dataset. Note that if this dataset doesn't already have license information attached, the license creation function (POST) should be used instead.
operationId: updateDatasetLicense
parameters:
- name: dataset-id
in: path
description: Dataset ID
required: true
schema:
type: string
requestBody:
description: The license
content:
application/json:
schema:
type: object
required: true
responses:
'204':
description: Dataset license updated
delete:
tags:
- license
summary: Remove license from a dataset
description: Remove the master license from a dataset. Note that any policies applied to individual documents and files will remain in place.
operationId: deleteDatasetLicense
parameters:
- name: dataset-id
in: path
required: true
schema:
type: string
responses:
'204':
description: Dataset license removed
/license/dataset/{dataset-id}/{doc_id}:
get:
tags:
- license
summary: Retrieve license information for a single dataset document
operationId: getDatasetDocumentLicense
parameters:
- name: dataset-id
in: path
description: Dataset ID
required: true
schema:
type: string
- name: doc_id
in: path
description: Document ID
required: true
schema:
type: string
responses:
'200':
description: Success
post:
tags:
- license
summary: Assign license information to a single dataset document
description: Assign a new license to a dataset document. Note that if this dataset document already has license information attached, the license update function (PUT) should be used instead.
operationId: createDatasetDocumentLicense
parameters:
- name: dataset-id
in: path
description: Dataset ID
required: true
schema:
type: string
- name: doc_id
in: path
description: Document ID
required: true
schema:
type: string
requestBody:
description: The license
content:
application/json:
schema:
type: object
required: true
responses:
'201':
description: Dataset document license added
put:
tags:
- license
summary: Update license information for a dataset document
description: Update an existing license for a single dataset document. Note that if this dataset document doesn't already have license information attached, the license creation function (POST) should be used instead.
operationId: updateDatasetDocumentLicense
parameters:
- name: dataset-id
in: path
description: Dataset ID
required: true
schema:
type: string
- name: doc_id
in: path
description: Document ID
required: true
schema:
type: string
requestBody:
description: The license
content:
application/json:
schema:
type: object
required: true
responses:
'204':
description: Dataset document license updated
delete:
tags:
- license
summary: Remove license from a dataset document
description: Remove the license from a single dataset document.
operationId: deleteDatasetDocumentLicense
parameters:
- name: dataset-id
in: path
required: true
schema:
type: string
- name: doc_id
in: path
description: Document ID
required: true
schema:
type: string
responses:
'204':
description: Dataset document license removed
/license/dataset/{dataset-id}/{filename}:
get:
tags:
- license
summary: Retrieve license information for a single dataset file
operationId: getDatasetFileLicense
parameters:
- name: dataset-id
in: path
description: Dataset ID
required: true
schema:
type: string
- name: filename
in: path
description: File name
required: true
schema:
type: string
responses:
'200':
description: Success
/changes/{dataset-id}:
get:
tags:
- changes
summary: Retrieve details of write activities on a dataset
operationId: getChanges
parameters:
- name: dataset-id
in: path
description: Dataset ID
required: true
schema:
type: string
- name: timestamp
in: query
description: Optionally only retrieve entries since this timestamp
required: false
schema:
type: integer
- name: limit
in: query
description: Optionally specify a limit on the number of entries returned (defaults to 100)
required: false
schema:
type: integer
- name: sort
in: query
description: Optionally reverse the sort order to retrieve items oldest-first
required: false
schema:
type: integer
enum:
- 1
responses:
'200':
description: Success
/schemas/{schema-id}:
get:
tags:
- schemas
summary: Retrieve schema
operationId: getSchema
parameters:
- name: schema-id
in: path
description: Schema name
example: person.json
required: true
schema:
type: string
responses:
'200':
description: Success
'404':
description: Schema not found
'500':
description: Fatal error retrieving schema
/query/{dataset-uuid}/sparql:
get:
tags:
- sparql
summary: Retrieve sparql
operationId: getSparql
parameters:
- name: dataset-uuid
in: path
description: Dataset name
required: true
schema:
type: string
- name: query
in: query
description: The SPARQL query
required: true
schema:
type: string
responses:
'200':
description: Query results
content:
application/sparql-results+json:
schema:
type: object
application/sparql-results+xml:
schema:
type: object
text/csv:
schema:
type: string
example: subject,predicate,object
text/tab-separated-values:openapi: 3.0.1
info:
title: API Factory - Object Stream API
description: Object Stream API
termsOfService: http://datahub.mksmart.org
contact:
email: [email protected]
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
version: 0.9.4
tags:
- name: browse
description: Browse a dataset, with full control over filters, pagination, sorting
- name: object
description: Create, retrieve, update and delete JSON documents
- name: file
description: Create, retrieve, update and delete files
- name: license
description: Create, retrieve, set and update licenses
- name: changes
description: Monitoring changes
- name: schemas
description: Retrieve a schema
- name: sparql
description: Perform a SPARQL query against the data
paths:
/browse/{dataset-uuid}:
get:
tags:
- browse
summary: Retrieve documents from the dataset
operationId: browseDocuments
parameters:
- name: dataset-uuid
in: path
description: dataset uuid identifier
required: true
schema:
type: string
- name: query
in: query
description: The filter query
required: false
schema:
type: string
- name: sort
in: query
description: Optionally specify fields on which to sort the data. Sort fields should be specified as a comma separated list. Data will be sorted in ascending order. To specify a field to sort in descending order precede that field with a minus ('-')
schema:
type: string
- name: fields
in: query
description: Optionally specify which fields to return. Fields should be specified as a comma separated list. Fields preceded with a minus ("-") will be excluded from the results. The "_id" field is always returned, unless explicitly excluded.
schema:
type: string
- name: pagesize
in: query
description: Optionally specify page size (defaults to a page size of 100)
schema:
minimum: 0
type: integer
- name: page
in: query
description: Optionally specify the page number of results to return (defaults to page 1)
schema:
minimum: 0
type: integer
responses:
'200':
description: Success
'400':
description: Bad request, malformed JSON
'500':
description: Fatal error creating object
/object/{dataset-uuid}:
get:
tags:
- object
summary: Retrieve documents from the dataset
operationId: getDocuments
parameters:
- name: dataset-uuid
in: path
description: dataset uuid identifier
required: true
schema:
type: string
- name: query
in: query
description: The filter query
required: false
schema:
type: string
- name: limit
in: query
description: Optionally limit the number of documents returned
schema:
minimum: 0
type: integer
responses:
'200':
description: Success
'400':
description: Bad request, malformed JSON
'500':
description: Fatal error creating object
post:
tags:
- object
summary: Create a new document in the dataset
operationId: createDocument
parameters:
- name: dataset-uuid
in: path
description: dataset uuid identifier
required: true
schema:
type: string
requestBody:
description: The document to be created
content:
application/json:
schema:
type: object
example:
_id: '1067'
sensorID: 42-a
sensorValue: 34.7
required: true
responses:
'201':
description: Object created
'400':
description: Bad request, malformed JSON
'500':
description: Fatal error creating object
/object/{dataset-uuid}/{doc_id}:
get:
tags:
- object
summary: Retrieve a single document from the dataset
operationId: getDocument
parameters:
- name: dataset-uuid
in: path
description: dataset uuid identifier
required: true
schema:
type: string
- name: doc_id
in: path
required: true
schema:
type: string
- name: limit
in: query
description: Optionally limit the number of documents returned
schema:
minimum: 0
type: integer
responses:
'200':
description: Success
'400':
description: Bad request, malformed JSON
'500':
description: Fatal error creating object
put:
tags:
- object
summary: Update a document by ID
description: Update an existing document, referenced by ID. Note that the existing document will be overwritten, so a full document should be supplied.
operationId: updateDocumentById
parameters:
- name: dataset-uuid
in: path
description: The UUID of the dataset
required: true
schema:
type: string
- name: doc_id
in: path
required: true
schema:
type: string
requestBody:
description: The updated document
content:
application/json:
schema:
type: object
required: true
responses:
'201':
description: Object creted
'204':
description: Object updated
'500':
description: Fatal error creating or updating object
delete:
tags:
- object
summary: Delete a document by ID
description: Delete an existing document, referenced by ID.
operationId: deleteDocumentById
parameters:
- name: dataset-uuid
in: path
description: The UUID of the dataset
required: true
schema:
type: string
- name: doc_id
in: path
required: true
schema:
type: string
responses:
'200':
description: No items to delete
'204':
description: Object deleted
'500':
description: Fatal error deleting object
/file/{dataset-id}:
get:
tags:
- file
summary: Retrieve a list of files for a single dataset
operationId: getFiles
parameters:
- name: dataset-id
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
post:
tags:
- file
summary: Upload a new file
operationId: createFile
parameters:
- name: dataset-id
in: path
required: true
schema:
type: string
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
title:
type: string
description:
type: string
file:
type: string
format: binary
responses:
'201':
description: File uploaded
/file/{dataset-id}/{filename}:
get:
tags:
- file
summary: Retrieve a single file
operationId: getFile
parameters:
- name: dataset-id
in: path
required: true
schema:
type: string
- name: filename
in: path
required: true
schema:
type: string
responses:
'200':