-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathopenapi.yaml
More file actions
5645 lines (5644 loc) · 135 KB
/
openapi.yaml
File metadata and controls
5645 lines (5644 loc) · 135 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.3
info:
title: Pangolin Catalog API
description: Multi-tenant Apache Iceberg REST Catalog with advanced features including federated catalogs, credential vending, and fine-grained permissions
contact:
name: Pangolin API Support
email: support@pangolin.dev
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: 1.0.0
paths:
/api/v1/access-requests:
get:
tags:
- Business Metadata
operationId: list_access_requests
responses:
'200':
description: List of access requests
'500':
description: Internal server error
security:
- bearer_auth: []
/api/v1/access-requests/{request_id}:
get:
tags:
- Business Metadata
operationId: get_access_request
parameters:
- name: request_id
in: path
description: Request ID
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Request details
'403':
description: Forbidden
'404':
description: Request not found
'500':
description: Internal server error
security:
- bearer_auth: []
put:
tags:
- Business Metadata
operationId: update_access_request
parameters:
- name: request_id
in: path
description: Request ID
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateRequestStatus'
required: true
responses:
'200':
description: Request updated
'400':
description: Bad request
'403':
description: Forbidden
'404':
description: Request not found
'500':
description: Internal server error
security:
- bearer_auth: []
/api/v1/app/config:
get:
tags:
- System Config
summary: Get public application configuration
operationId: get_app_config
responses:
'200':
description: App config
content:
application/json:
schema:
$ref: '#/components/schemas/AppConfig'
/api/v1/assets/search:
get:
tags:
- Business Metadata
operationId: search_assets
responses:
'200':
description: Search results
'500':
description: Internal server error
security:
- bearer_auth: []
/api/v1/assets/{asset_id}:
get:
tags:
- Business Metadata
operationId: get_asset_details
parameters:
- name: asset_id
in: path
description: Asset ID
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Asset details with metadata
'403':
description: Forbidden
'404':
description: Asset not found
'500':
description: Internal server error
security:
- bearer_auth: []
/api/v1/assets/{asset_id}/access-requests:
post:
tags:
- Business Metadata
operationId: request_access
parameters:
- name: asset_id
in: path
description: Asset ID
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAccessRequestPayload'
required: true
responses:
'201':
description: Access request created
'500':
description: Internal server error
security:
- bearer_auth: []
/api/v1/assets/{asset_id}/metadata:
get:
tags:
- Business Metadata
operationId: get_business_metadata
parameters:
- name: asset_id
in: path
description: Asset ID
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Metadata retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/MetadataResponse'
'404':
description: Metadata not found
'500':
description: Internal server error
security:
- bearer_auth: []
delete:
tags:
- Business Metadata
operationId: delete_business_metadata
parameters:
- name: asset_id
in: path
description: Asset ID
required: true
schema:
type: string
format: uuid
responses:
'204':
description: Metadata deleted
'500':
description: Internal server error
security:
- bearer_auth: []
/api/v1/audit:
get:
tags:
- Audit Logging
summary: List audit events with optional filtering
description: |-
Returns a list of audit events with support for powerful filtering and pagination.
All filters are optional and can be combined.
operationId: list_audit_events
parameters:
- name: user_id
in: query
description: Filter by user UUID
required: false
schema:
type: string
format: uuid
nullable: true
- name: action
in: query
description: Filter by action (e.g., 'create_table')
required: false
schema:
type: string
nullable: true
- name: resource_type
in: query
description: Filter by resource type (e.g., 'table')
required: false
schema:
type: string
nullable: true
- name: resource_id
in: query
description: Filter by resource UUID
required: false
schema:
type: string
format: uuid
nullable: true
- name: start_time
in: query
description: Filter by start time (ISO 8601)
required: false
schema:
type: string
nullable: true
- name: end_time
in: query
description: Filter by end time (ISO 8601)
required: false
schema:
type: string
nullable: true
- name: result
in: query
description: Filter by result ('success' or 'failure')
required: false
schema:
type: string
nullable: true
- name: limit
in: query
description: 'Maximum results (default: 100, max: 1000)'
required: false
schema:
type: integer
nullable: true
minimum: 0
- name: offset
in: query
description: Skip N results for pagination
required: false
schema:
type: integer
nullable: true
minimum: 0
responses:
'200':
description: List of audit events
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AuditLogEntry'
'500':
description: Internal server error
security:
- bearer_auth: []
/api/v1/audit/count:
get:
tags:
- Audit Logging
summary: Count audit events with optional filtering
description: |-
Returns the total count of audit events matching the specified filters.
Accepts the same query parameters as list_audit_events.
operationId: count_audit_events
parameters:
- name: user_id
in: query
description: Filter by user UUID
required: false
schema:
type: string
format: uuid
nullable: true
- name: action
in: query
description: Filter by action (e.g., 'create_table')
required: false
schema:
type: string
nullable: true
- name: resource_type
in: query
description: Filter by resource type (e.g., 'table')
required: false
schema:
type: string
nullable: true
- name: resource_id
in: query
description: Filter by resource UUID
required: false
schema:
type: string
format: uuid
nullable: true
- name: start_time
in: query
description: Filter by start time (ISO 8601)
required: false
schema:
type: string
nullable: true
- name: end_time
in: query
description: Filter by end time (ISO 8601)
required: false
schema:
type: string
nullable: true
- name: result
in: query
description: Filter by result ('success' or 'failure')
required: false
schema:
type: string
nullable: true
responses:
'200':
description: Count of audit events
content:
application/json:
schema:
$ref: '#/components/schemas/AuditCountResponse'
'500':
description: Internal server error
security:
- bearer_auth: []
/api/v1/audit/{event_id}:
get:
tags:
- Audit Logging
summary: Get a specific audit event by ID
description: Retrieves a single audit event by its unique identifier.
operationId: get_audit_event
parameters:
- name: event_id
in: path
description: Audit event ID
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Audit event details
content:
application/json:
schema:
$ref: '#/components/schemas/AuditLogEntry'
'404':
description: Audit event not found
'500':
description: Internal server error
security:
- bearer_auth: []
/api/v1/auth/revoke:
post:
tags:
- Tokens
summary: Revoke the current user's token (logout)
operationId: revoke_current_token
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RevokeTokenRequest'
required: true
responses:
'200':
description: Token revoked
content:
application/json:
schema:
$ref: '#/components/schemas/RevokeTokenResponse'
'500':
description: Internal server error
security:
- bearer_auth: []
/api/v1/auth/revoke/{token_id}:
post:
tags:
- Tokens
summary: Admin endpoint to revoke any token by ID
operationId: revoke_token_by_id
parameters:
- name: token_id
in: path
description: Token ID to revoke
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RevokeTokenRequest'
required: true
responses:
'200':
description: Token revoked
content:
application/json:
schema:
$ref: '#/components/schemas/RevokeTokenResponse'
'500':
description: Internal server error
security:
- bearer_auth: []
/api/v1/auth/tokens/cleanup:
post:
tags:
- Tokens
summary: Admin endpoint to clean up expired tokens
description: Admin endpoint to clean up expired tokens
operationId: cleanup_expired_tokens
responses:
'200':
description: Cleaned up expired tokens
content:
application/json:
schema: {}
'403':
description: Forbidden
'500':
description: Internal server error
security:
- bearer_auth: []
/api/v1/branches:
get:
tags:
- Branches
operationId: list_branches
responses:
'200':
description: List of branches
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BranchResponse'
'500':
description: Internal server error
security:
- bearer_auth: []
post:
tags:
- Branches
operationId: create_branch
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateBranchRequest'
required: true
responses:
'201':
description: Branch created
content:
application/json:
schema:
$ref: '#/components/schemas/BranchResponse'
'403':
description: Forbidden
'404':
description: Catalog not found
'500':
description: Internal server error
security:
- bearer_auth: []
/api/v1/branches/merge:
post:
tags:
- Branches
operationId: merge_branch
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MergeBranchRequest'
required: true
responses:
'200':
description: Branches merged successfully
'400':
description: Cannot merge experimental branch
'404':
description: Branch not found
'500':
description: Internal server error
security:
- bearer_auth: []
/api/v1/branches/{name}:
get:
tags:
- Branches
operationId: get_branch
parameters:
- name: name
in: path
description: Branch name
required: true
schema:
type: string
responses:
'200':
description: Branch details
content:
application/json:
schema:
$ref: '#/components/schemas/BranchResponse'
'404':
description: Branch not found
'500':
description: Internal server error
security:
- bearer_auth: []
/api/v1/branches/{name}/rebase:
post:
tags:
- Branches
summary: Rebase a branch onto main (merge main into branch)
operationId: rebase_branch
parameters:
- name: name
in: path
description: Branch name
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateBranchRequest'
required: true
responses:
'200':
description: Rebase successful
'500':
description: Internal server error
security:
- bearer_auth: []
/api/v1/bulk/assets/delete:
post:
tags:
- Bulk Operations
summary: Bulk delete multiple assets
description: |-
Deletes up to 100 assets in a single request.
Returns detailed results including any errors.
operationId: bulk_delete_assets
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BulkDeleteAssetsRequest'
required: true
responses:
'200':
description: Bulk delete results
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperationResponse'
'400':
description: Bad request (e.g., too many assets)
'500':
description: Internal server error
security:
- bearer_auth: []
/api/v1/catalogs:
get:
tags:
- Catalogs
operationId: list_catalogs
responses:
'200':
description: List of catalogs
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CatalogResponse'
'500':
description: Internal server error
security:
- bearer_auth: []
post:
tags:
- Catalogs
operationId: create_catalog
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCatalogRequest'
required: true
responses:
'201':
description: Catalog created
content:
application/json:
schema:
$ref: '#/components/schemas/CatalogResponse'
'400':
description: Bad request
'403':
description: Forbidden for root user
'500':
description: Internal server error
security:
- bearer_auth: []
/api/v1/catalogs/{catalog_name}/merge-operations:
get:
tags:
- Merge Operations
summary: List all merge operations for a catalog
operationId: list_merge_operations
parameters:
- name: catalog_name
in: path
description: Catalog name
required: true
schema:
type: string
responses:
'200':
description: List of merge operations
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MergeOperationResponse'
'500':
description: Internal server error
security:
- bearer_auth: []
/api/v1/catalogs/{catalog_name}/namespaces/{namespace}/assets:
get:
tags:
- Assets
summary: List all assets in a namespace (Iceberg tables + Generic assets)
operationId: list_assets
parameters:
- name: catalog_name
in: path
description: Catalog name
required: true
schema:
type: string
- name: namespace
in: path
description: Namespace
required: true
schema:
type: string
responses:
'200':
description: List of assets
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AssetSummary'
'404':
description: Catalog not found
'500':
description: Internal server error
security:
- bearer_auth: []
post:
tags:
- Assets
summary: Register a generic (non-Iceberg) asset for discovery and metadata management
operationId: register_asset
parameters:
- name: catalog_name
in: path
description: Catalog name
required: true
schema:
type: string
- name: namespace
in: path
description: Namespace
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterAssetRequest'
required: true
responses:
'201':
description: Asset registered
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterAssetResponse'
'403':
description: Forbidden
'404':
description: Catalog not found
'500':
description: Internal server error
security:
- bearer_auth: []
/api/v1/catalogs/{name}:
get:
tags:
- Catalogs
operationId: get_catalog
parameters:
- name: name
in: path
description: Catalog name
required: true
schema:
type: string
responses:
'200':
description: Catalog details
content:
application/json:
schema:
$ref: '#/components/schemas/CatalogResponse'
'404':
description: Catalog not found
'500':
description: Internal server error
security:
- bearer_auth: []
put:
tags:
- Catalogs
operationId: update_catalog
parameters:
- name: name
in: path
description: Catalog name
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateCatalogRequest'
required: true
responses:
'200':
description: Catalog updated
content:
application/json:
schema:
$ref: '#/components/schemas/CatalogResponse'
'404':
description: Catalog not found
'500':
description: Internal server error
security:
- bearer_auth: []
delete:
tags:
- Catalogs
operationId: delete_catalog
parameters:
- name: name
in: path
description: Catalog name
required: true
schema:
type: string
responses:
'204':
description: Catalog deleted
'500':
description: Internal server error
security:
- bearer_auth: []
/api/v1/catalogs/{name}/summary:
get:
tags:
- Catalogs
summary: Get summary statistics for a specific catalog
operationId: get_catalog_summary
parameters:
- name: name
in: path
description: Catalog name
required: true
schema:
type: string
responses:
'200':
description: Catalog summary
content:
application/json:
schema:
$ref: '#/components/schemas/CatalogSummary'
'404':
description: Catalog not found
'500':
description: Internal server error
security:
- bearer_auth: []
/api/v1/catalogs/{prefix}/namespaces/tree:
get:
tags:
- Data Explorer
summary: List namespace tree structure for a catalog
operationId: list_namespaces_tree
parameters:
- name: prefix
in: path
description: Catalog name
required: true
schema:
type: string
responses:
'200':
description: Namespace tree structure
'403':
description: Forbidden
'404':
description: Catalog not found
'500':
description: Internal server error
security:
- bearer_auth: []
/api/v1/catalogs/{prefix}/namespaces/{namespace}/tables/{table}/maintenance:
post:
tags:
- Data Explorer
summary: Perform maintenance on a table
operationId: perform_maintenance
parameters:
- name: prefix
in: path
description: Catalog name
required: true
schema:
type: string
- name: namespace
in: path
description: Namespace
required: true
schema:
type: string
- name: table
in: path
description: Table
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MaintenanceRequest'
required: true
responses:
'200':
description: Maintenance accepted
content:
application/json:
schema: {}
'400':
description: Bad request
'500':
description: Internal server error
security:
- bearer_auth: []
/api/v1/config/settings:
get:
tags:
- System Config
summary: Get system settings
operationId: get_system_settings
responses:
'200':
description: System settings
content:
application/json:
schema:
$ref: '#/components/schemas/SystemSettings'
'500':
description: Internal server error
security:
- bearer_auth: []
put:
tags:
- System Config
summary: Update system settings
operationId: update_system_settings
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SystemSettings'
required: true
responses:
'200':
description: Settings updated
content:
application/json:
schema:
$ref: '#/components/schemas/SystemSettings'
'500':
description: Internal server error
security:
- bearer_auth: []
/api/v1/conflicts/{conflict_id}/resolve:
post:
tags:
- Merge Operations
summary: Resolve a specific conflict
operationId: resolve_conflict
parameters:
- name: conflict_id
in: path
description: Conflict ID
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ResolveConflictRequest'
required: true
responses:
'200':
description: Conflict resolved
'500':
description: Internal server error
security:
- bearer_auth: []
/api/v1/dashboard/stats:
get:
tags:
- Dashboard
summary: Get dashboard statistics based on user role
description: |-
Returns different scopes based on user role:
- Root: system-wide statistics
- Tenant Admin: tenant-wide statistics
- Tenant User: statistics for accessible resources
operationId: get_dashboard_stats
responses:
'200':
description: Dashboard statistics
content:
application/json:
schema:
$ref: '#/components/schemas/DashboardStats'
'500':
description: Internal server error