-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtdei-api-gateway-stage.json
More file actions
4191 lines (4191 loc) · 190 KB
/
tdei-api-gateway-stage.json
File metadata and controls
4191 lines (4191 loc) · 190 KB
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": "TDEI Gateway Stage API",
"description": "This is an API for interacting with the Transportation Data Equity Initiative (TDEI) data system. It is intended for applications producing data to and consuming data from the TDEI system. It currently supports GTFS-Pathways, GTFS-Flex v2 and OpenSidewalks v0.2 data schemas.",
"contact": {
"name": "TDEI",
"url": "http://www.tdei.us/",
"email": "admin@tdei.us"
},
"version": "v0.1"
},
"servers": [
{
"url": "https://api-stage.tdei.us/",
"description": "TDEI API Gateway"
}
],
"security": [
{
"ApiKey": []
},
{
"AuthorizationToken": []
}
],
"paths": {
"/api/v1/authenticate": {
"post": {
"tags": [
"Authentication"
],
"summary": "Authenticates the user with the TDEI system.",
"description": "Authenticates the user with the TDEI system. Returns an access token, if successfully authenticated.",
"operationId": "authenticate",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Authentication successful - Returns the access token for the user.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TokenResponse"
}
}
}
},
"400": {
"description": "Password does not satisfiy with password policy."
},
"401": {
"description": "Authentication failed - Check username and password."
},
"404": {
"description": "User not found."
},
"500": {
"description": "An Internal server error occured"
}
}
}
},
"/api/v1/refresh-token": {
"post": {
"tags": [
"Authentication"
],
"summary": "Re-issue an access token",
"description": "Re-issues an access token, if a valid refresh token is sent to the server",
"operationId": "refreshToken",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "string",
"description": "The refresh token that was sent through authentication or refresh token API"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful validation of refresh token - Returns the refreshed access token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TokenResponse"
}
}
}
},
"401": {
"description": "Invalid or expired refresh token provided."
},
"500": {
"description": "An Internal server error occured"
}
}
}
},
"/api/v1/datasets": {
"get": {
"tags": [
"Common APIs"
],
"summary": "Lists the TDEI datasets in the system.",
"description": "This API lists all TDEI datasets, allowing users to efficiently search with sorting and filtering features. Each dataset entry is uniquely identified by `tdei_dataset_id` and also provide detailed information including metadata, associated project group, service details, download URL, and status. Users can sort datasets by 'valid_to', 'valid_from', 'uploaded date', 'project group name', and 'status'. Filtering options are provided for enhanced discoverability of the datasets.By default all released datasets are visible to all user. Pre-release datasets are only visible to user affiliated with the project groups.",
"operationId": "listDatasetFiles",
"parameters": [
{
"name": "data_type",
"in": "query",
"description": "Type of the dataset.",
"required": false,
"schema": {
"type": "string",
"enum": [
"osw",
"flex",
"pathways"
]
}
},
{
"name": "status",
"in": "query",
"description": "This filter allows users to request datasets based on their status. When set to 'All', the filter displays all available datasets by default. If specified as 'Pre-Release' or 'Publish', it shows only the datasets that are in the Pre-Release or Publish stages, respectively, for the project groups the user is affiliated with.",
"required": false,
"schema": {
"type": "string",
"enum": [
"Publish",
"Pre-Release",
"All"
],
"default": "All"
}
},
{
"name": "name",
"in": "query",
"description": "Dataset name or title",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "query",
"description": "Dataset version.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "data_source",
"in": "query",
"description": "Data source of the dataset.",
"required": false,
"schema": {
"type": "string",
"enum": [
"3rdParty",
"TDEITools",
"InHouse"
]
}
},
{
"name": "collection_method",
"in": "query",
"description": "Method by which the data was collected.",
"required": false,
"schema": {
"type": "string",
"enum": [
"manual",
"transform",
"generated",
"other"
]
}
},
{
"name": "collected_by",
"in": "query",
"description": "Collection agency or person.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "derived_from_dataset_id",
"in": "query",
"description": "Dataset id from which this dataset was derived.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "collection_date",
"in": "query",
"description": "Collection date time",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "confidence_level",
"description": "Minimum confidence level required. Data returned will be at this confidence level or higher. Confidence level range is: 0 (very low confidence) to 100 (very high confidence).",
"schema": {
"type": "integer"
},
"in": "query"
},
{
"name": "schema_version",
"in": "query",
"description": "Version name of the data type schema version that the application requests. list of versions can be found with /api/v1/{data_type}/versions.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "tdei_project_group_id",
"in": "query",
"description": "TDEI project group id of the datasets to be retrieved.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "tdei_service_id",
"in": "query",
"description": "TDEI service id of the datasets to be retrieved.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "valid_from",
"in": "query",
"description": "Valid from date time. Date-time for which datasets to be retrieved.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "valid_to",
"in": "query",
"description": "Valid to date time. Date-time for which datasets to be retrieved.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "tdei_dataset_id",
"in": "query",
"description": "tdei_dataset_id of the dataset to be retrieved.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "bbox",
"in": "query",
"description": "A bounding box which specifies the area to be searched. A bounding box is specified by a string providing the lat/lon coordinates of the corners of the bounding box. Coordinate should be specified as west, south, east, north.",
"required": false,
"schema": {
"maxItems": 4,
"minItems": 4,
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"example": [
-122.153539,
47.635463,
-122.116939,
47.65387
]
},
{
"name": "other_published_locations",
"in": "query",
"description": "Other published locations",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "dataset_update_frequency_months",
"in": "query",
"description": "Dataset update frequency in months",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "schema_validation_run_description",
"in": "query",
"description": "Schema validation run description",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "full_dataset_name",
"in": "query",
"description": "Full dataset name",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "collection_name",
"in": "query",
"description": "Name of the collection",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "department_name",
"in": "query",
"description": "Name of the department",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "city",
"in": "query",
"description": "Name of the city",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "region",
"in": "query",
"description": "Name of the region",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "county",
"in": "query",
"description": "Name of the county",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "key_limitations",
"in": "query",
"description": "Key limitations of the dataset",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "release_notes",
"in": "query",
"description": "Release notes",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "challenges",
"in": "query",
"description": "Challenges faced in collecting the data",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "official_maintainer",
"in": "query",
"description": "Official maintainer of the dataset",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "last_updated",
"in": "query",
"description": "Date when the dataset was last updated",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "update_frequency",
"in": "query",
"description": "Frequency of updates",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "authorization_chain",
"in": "query",
"description": "Authorization chain",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "maintenance_funded",
"in": "query",
"description": "Is maintenance funded",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "funding_details",
"in": "query",
"description": "Funding details",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "point_data_collection_device",
"in": "query",
"description": "Point data collection device",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "node_locations_and_attributes_editing_software",
"in": "query",
"description": "Node locations and attributes editing software",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "data_collected_by_people",
"in": "query",
"description": "Is data collected by people",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "data_collectors",
"in": "query",
"description": "Data collectors",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "data_captured_automatically",
"in": "query",
"description": "Is data captured automatically",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "automated_collection",
"in": "query",
"description": "Automated collection",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "data_collectors_organization",
"in": "query",
"description": "Data collectors organization",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "data_collector_compensation",
"in": "query",
"description": "Data collector compensation",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "preprocessing_location",
"in": "query",
"description": "Preprocessing location",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "preprocessing_by",
"in": "query",
"description": "Preprocessing by",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "preprocessing_steps",
"in": "query",
"description": "Preprocessing steps",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "data_collection_preprocessing_documentation",
"in": "query",
"description": "Is data collection preprocessing documentation available",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "documentation_uri",
"in": "query",
"description": "Documentation URI",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "validation_process_exists",
"in": "query",
"description": "Is validation process exists",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "validation_process_description",
"in": "query",
"description": "Validation process description",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "validation_conducted_by",
"in": "query",
"description": "Validation conducted by",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "excluded_data",
"in": "query",
"description": "Excluded data",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "excluded_data_reason",
"in": "query",
"description": "Excluded data reason",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page_no",
"in": "query",
"description": "Integer, defaults to 1. Retrieves the results in pages.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "page_size",
"in": "query",
"description": "Page size. integer, between 1 to 50, defaults to 10.Specifies total records per page.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 10
}
},
{
"name": "sort_field",
"in": "query",
"description": "Sort field. By default, it is by uploaded timestamp.",
"required": false,
"schema": {
"type": "string",
"enum": [
"status",
"valid_from",
"valid_to",
"uploaded_timestamp",
"project_group_name"
],
"default": "uploaded_timestamp"
}
},
{
"name": "sort_order",
"in": "query",
"description": "Sort order. By default, it is in descending order.",
"required": false,
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
],
"default": "desc"
}
}
],
"responses": {
"200": {
"description": "Successful response - returns an array of dataset entities.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DatasetItem"
}
}
}
}
},
"400": {
"description": "Bad input request."
},
"401": {
"description": "Unauthenticated request. Check your access token."
},
"500": {
"description": "An Internal server error occured"
}
},
"security": [
{
"ApiKey": []
},
{
"AuthorizationToken": []
}
]
}
},
"/api/v1/metadata/{tdei_dataset_id}": {
"put": {
"tags": [
"Common APIs"
],
"summary": "Updates the metadata of a given dataset",
"description": "Updates the metadata of a dataset with the metadata in the provided file. Returns status 200 if the action is successful.",
"operationId": "editMetadata",
"parameters": [
{
"name": "tdei_dataset_id",
"in": "path",
"description": "Must be a valid TDEI dataset id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"file"
],
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "Metadata file. see [metadata schema](https://raw.githubusercontent.com/TaskarCenterAtUW/TDEI-osw-datasvc-ts/stage/schema/metadata.schema.json)"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successfully updated the metadata."
},
"400": {
"description": "The request was invalid. The metadata file provided doesn't adhere to the metadata schema."
},
"401": {
"description": "Unauthenticated request. Check your access token."
},
"403": {
"description": "User unauthorized to update metadata."
},
"404": {
"description": "Given TDEI dataset ID doesnt exist."
},
"500": {
"description": "An Internal server error occured"
}
},
"security": [
{
"AuthorizationToken": []
}
]
}
},
"/api/v1/dataset/clone/{tdei_dataset_id}/{tdei_project_group_id}/{tdei_service_id}": {
"post": {
"tags": [
"Common APIs"
],
"summary": "Clones the provided dataset to the designated project group and service.",
"description": "Cloning of a dataset lets one to use the dataset being cloned as the base for a new dataset without having to upload the dataset. This operation clones the datafiles in the dataset `tdei_dataset_id` to the designated project group `tdei_project_group_id` and service `tdei_service_id`, and uses the metadata file provided along with the API as the metadata. Returns cloned dataset id if the action is successful. ",
"operationId": "cloneDataset",
"parameters": [
{
"name": "tdei_dataset_id",
"in": "path",
"description": "Valid TDEI dataset id to be cloned.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tdei_project_group_id",
"in": "path",
"description": "Valid TDEI project group id.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tdei_service_id",
"in": "path",
"description": "Valid TDEI service id associated with the project group.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"file"
],
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "Metadata file. see [metadata schema](https://raw.githubusercontent.com/TaskarCenterAtUW/TDEI-osw-datasvc-ts/stage/schema/metadata.schema.json)"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Cloning of the dataset successful. ID of the newly cloned dataset returned.",
"content": {
"application/json": {
"schema": {
"type": "string",
"description": "Cloned dataset ID",
"example": "5f7b1b3b-7b7b-4b7b-8b7b-9b7b1b3b7b7b"
}
}
}
},
"400": {
"description": "The request was invalid."
},
"401": {
"description": "Unauthenticated request. Check your access token."
},
"403": {
"description": "User unauthorized to clone the dataset."
},
"404": {
"description": "tdei_dataset_id, tdei_project_group_id or tdei_service_id doesn't exist in the system"
},
"500": {
"description": "An Internal server error occured"
}
},
"security": [
{
"AuthorizationToken": []
}
]
}
},
"/api/v1/jobs": {
"get": {
"tags": [
"Common APIs"
],
"summary": "Shows the details of the jobs that the user has access to.",
"description": "Returns a list of jobs including request and reponse details. By default only shows the jobs that are submitted by the user.",
"operationId": "listJobs",
"parameters": [
{
"name": "job_id",
"in": "query",
"description": "Get the details for the job with id=job_id only.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "tdei_project_group_id",
"in": "query",
"description": "project group id of the user for which the jobs are listed for.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "show_group_jobs",
"in": "query",
"description": "Make this `true` to see the jobs submitted by others also in the given project group",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "job_type",
"in": "query",
"description": "Use this to filter for a specific type of job",
"required": false,
"schema": {
"type": "string",
"enum": [
"Clone-Dataset",
"Confidence-Calculate",
"Dataset-BBox",
"Dataset-Incline-Tag",
"Dataset-Publish",
"Dataset-Reformat",
"Dataset-Road-Tag",
"Dataset-Spatial-Join",
"Dataset-Union",
"Dataset-Upload",
"Dataset-Validate",
"Edit-Metadata",
"Quality-Metric"
]
}
},
{
"name": "status",
"in": "query",
"description": "Status of the job. Use this to filter jobs by a specific status",
"required": false,
"schema": {
"type": "string",
"enum": [
"COMPLETED",
"FAILED",
"IN-PROGRESS",
"ABANDONED"
]
}
},
{
"name": "page_no",
"in": "query",
"description": "Pagination: page number to start the list from. Defaults to 1.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "page_size",
"in": "query",
"description": "Total records to retrieve.Page size ranges between 1 to 50, defaults to 10.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 10
}
}
],
"responses": {
"200": {
"description": "Successful response - returns an array of [JobDetails](#/components/schemas/JobDetails) entities.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JobDetails"
}
}
}
}
},
"400": {
"description": "The request is invalid."
},
"401": {
"description": "Unauthenticated request. Check your access token."
},
"404": {
"description": "job_id or tdei_project_group_id doesn't exist in the system"