rustberg 0.0.2

A production-grade, cross-platform, single-binary Apache Iceberg REST Catalog
Documentation
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
//! OpenAPI specification for Rustberg Iceberg REST Catalog.
//!
//! Provides OpenAPI 3.0 specification based on the Iceberg REST Catalog spec.

use serde::{Deserialize, Serialize};
use std::collections::HashMap;

/// Rustberg OpenAPI documentation.
pub struct ApiDoc;

impl ApiDoc {
    /// Returns the OpenAPI specification as JSON.
    pub fn json() -> String {
        serde_json::to_string_pretty(&Self::spec()).unwrap()
    }

    /// Returns the OpenAPI specification as YAML.
    pub fn yaml() -> String {
        OPENAPI_YAML.replace("{{VERSION}}", env!("CARGO_PKG_VERSION"))
    }

    /// Returns the OpenAPI specification as a struct.
    pub fn spec() -> OpenApiSpec {
        OpenApiSpec {
            openapi: "3.0.3".to_string(),
            info: Info {
                title: "Rustberg - Apache Iceberg REST Catalog".to_string(),
                version: env!("CARGO_PKG_VERSION").to_string(),
                description: "A production-grade, single-binary Apache Iceberg REST Catalog server written in Rust. This API implements the Apache Iceberg REST Catalog Specification.".to_string(),
                license: License {
                    name: "Apache-2.0".to_string(),
                    url: "https://www.apache.org/licenses/LICENSE-2.0".to_string(),
                },
                contact: Contact {
                    name: "Rustberg".to_string(),
                    url: "https://github.com/hupe1980/rustberg".to_string(),
                },
            },
            servers: vec![Server {
                url: "/".to_string(),
                description: "Default server".to_string(),
            }],
            tags: vec![
                Tag { name: "config".to_string(), description: "Server configuration endpoints".to_string() },
                Tag { name: "namespaces".to_string(), description: "Namespace management operations".to_string() },
                Tag { name: "tables".to_string(), description: "Table management operations".to_string() },
                Tag { name: "health".to_string(), description: "Health check endpoints".to_string() },
                Tag { name: "metrics".to_string(), description: "Observability endpoints".to_string() },
            ],
            paths: HashMap::new(),
            components: Components {
                security_schemes: HashMap::new(),
                schemas: HashMap::new(),
            },
        }
    }
}

// ============================================================================
// Static OpenAPI YAML
// ============================================================================

const OPENAPI_YAML: &str = r##"openapi: "3.0.3"
info:
  title: "Rustberg - Apache Iceberg REST Catalog"
  version: "{{VERSION}}"
  description: |
    A production-grade, single-binary Apache Iceberg REST Catalog server written in Rust.
    
    This API implements the Apache Iceberg REST Catalog Specification.
  license:
    name: "Apache-2.0"
    url: "https://www.apache.org/licenses/LICENSE-2.0"
  contact:
    name: "Rustberg"
    url: "https://github.com/hupe1980/rustberg"

servers:
  - url: "/"
    description: "Default server"

tags:
  - name: config
    description: Server configuration endpoints
  - name: namespaces
    description: Namespace management operations
  - name: tables
    description: Table management operations
  - name: search
    description: Catalog search and discovery
  - name: auth
    description: Authentication introspection endpoints
  - name: health
    description: Health check endpoints
  - name: metrics
    description: Observability endpoints

paths:
  /v1/config:
    get:
      tags: [config]
      summary: Get server configuration
      operationId: getConfig
      security:
        - api_key: []
        - bearer_auth: []
      responses:
        "200":
          description: Server configuration
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ConfigResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"

  /v1/namespaces:
    get:
      tags: [namespaces]
      summary: List all namespaces
      operationId: listNamespaces
      security:
        - api_key: []
        - bearer_auth: []
      parameters:
        - name: pageToken
          in: query
          description: Pagination token
          schema:
            type: string
        - name: pageSize
          in: query
          description: Number of items to return
          schema:
            type: integer
      responses:
        "200":
          description: List of namespaces
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListNamespacesResponse"
        "401":
          description: Unauthorized
    post:
      tags: [namespaces]
      summary: Create a namespace
      operationId: createNamespace
      security:
        - api_key: []
        - bearer_auth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateNamespaceRequest"
      responses:
        "200":
          description: Created namespace
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/NamespaceResponse"
        "400":
          description: Invalid request
        "401":
          description: Unauthorized
        "409":
          description: Namespace already exists

  /v1/namespaces/{namespace}:
    get:
      tags: [namespaces]
      summary: Get namespace metadata
      operationId: getNamespace
      security:
        - api_key: []
        - bearer_auth: []
      parameters:
        - name: namespace
          in: path
          required: true
          description: Namespace identifier
          schema:
            type: string
      responses:
        "200":
          description: Namespace metadata
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/NamespaceResponse"
        "401":
          description: Unauthorized
        "404":
          description: Namespace not found
    head:
      tags: [namespaces]
      summary: Check if namespace exists
      operationId: namespaceExists
      security:
        - api_key: []
        - bearer_auth: []
      parameters:
        - name: namespace
          in: path
          required: true
          schema:
            type: string
      responses:
        "204":
          description: Namespace exists
        "404":
          description: Namespace not found
    delete:
      tags: [namespaces]
      summary: Delete a namespace
      operationId: deleteNamespace
      security:
        - api_key: []
        - bearer_auth: []
      parameters:
        - name: namespace
          in: path
          required: true
          schema:
            type: string
      responses:
        "204":
          description: Namespace deleted
        "401":
          description: Unauthorized
        "404":
          description: Namespace not found

  /v1/namespaces/{namespace}/properties:
    post:
      tags: [namespaces]
      summary: Update namespace properties
      operationId: updateNamespaceProperties
      security:
        - api_key: []
        - bearer_auth: []
      parameters:
        - name: namespace
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateNamespaceRequest"
      responses:
        "200":
          description: Updated namespace properties
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/UpdateNamespaceResponse"
        "401":
          description: Unauthorized
        "404":
          description: Namespace not found

  /v1/namespaces/{namespace}/tables:
    get:
      tags: [tables]
      summary: List tables in a namespace
      operationId: listTables
      security:
        - api_key: []
        - bearer_auth: []
      parameters:
        - name: namespace
          in: path
          required: true
          schema:
            type: string
        - name: pageToken
          in: query
          schema:
            type: string
        - name: pageSize
          in: query
          schema:
            type: integer
      responses:
        "200":
          description: List of tables
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListTablesResponse"
        "401":
          description: Unauthorized
        "404":
          description: Namespace not found
    post:
      tags: [tables]
      summary: Create a table
      operationId: createTable
      security:
        - api_key: []
        - bearer_auth: []
      parameters:
        - name: namespace
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateTableRequest"
      responses:
        "200":
          description: Created table
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LoadTableResponse"
        "400":
          description: Invalid request
        "401":
          description: Unauthorized
        "404":
          description: Namespace not found
        "409":
          description: Table already exists

  /v1/namespaces/{namespace}/tables/{table}:
    get:
      tags: [tables]
      summary: Load table metadata
      operationId: loadTable
      security:
        - api_key: []
        - bearer_auth: []
      parameters:
        - name: namespace
          in: path
          required: true
          schema:
            type: string
        - name: table
          in: path
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Table metadata
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LoadTableResponse"
        "401":
          description: Unauthorized
        "404":
          description: Table not found
    head:
      tags: [tables]
      summary: Check if table exists
      operationId: tableExists
      security:
        - api_key: []
        - bearer_auth: []
      parameters:
        - name: namespace
          in: path
          required: true
          schema:
            type: string
        - name: table
          in: path
          required: true
          schema:
            type: string
      responses:
        "204":
          description: Table exists
        "404":
          description: Table not found
    post:
      tags: [tables]
      summary: Commit table changes
      operationId: commitTable
      security:
        - api_key: []
        - bearer_auth: []
      parameters:
        - name: namespace
          in: path
          required: true
          schema:
            type: string
        - name: table
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CommitTableRequest"
      responses:
        "200":
          description: Updated table metadata
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CommitTableResponse"
        "400":
          description: Invalid request
        "401":
          description: Unauthorized
        "404":
          description: Table not found
        "409":
          description: Commit conflict
    delete:
      tags: [tables]
      summary: Delete a table
      operationId: dropTable
      security:
        - api_key: []
        - bearer_auth: []
      parameters:
        - name: namespace
          in: path
          required: true
          schema:
            type: string
        - name: table
          in: path
          required: true
          schema:
            type: string
        - name: purgeRequested
          in: query
          description: Whether to purge underlying data files
          schema:
            type: boolean
      responses:
        "204":
          description: Table deleted
        "401":
          description: Unauthorized
        "404":
          description: Table not found

  /v1/tables/rename:
    post:
      tags: [tables]
      summary: Rename a table
      operationId: renameTable
      security:
        - api_key: []
        - bearer_auth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/RenameTableRequest"
      responses:
        "204":
          description: Table renamed
        "400":
          description: Invalid request
        "401":
          description: Unauthorized
        "404":
          description: Table not found

  /v1/namespaces/{namespace}/register:
    post:
      tags: [tables]
      summary: Register an existing table from metadata
      operationId: registerTable
      description: Register a table using a metadata file location. The table must not already exist in the catalog.
      security:
        - api_key: []
        - bearer_auth: []
      parameters:
        - name: namespace
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/RegisterTableRequest"
      responses:
        "200":
          description: Registered table
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LoadTableResponse"
        "400":
          description: Invalid request
        "401":
          description: Unauthorized
        "404":
          description: Namespace not found
        "409":
          description: Table already exists

  /v1/namespaces/{namespace}/tables/{table}/metrics:
    post:
      tags: [tables]
      summary: Report scan or commit metrics
      operationId: reportMetrics
      description: Endpoint for clients to report table scan and commit metrics for telemetry.
      security:
        - api_key: []
        - bearer_auth: []
      parameters:
        - name: namespace
          in: path
          required: true
          schema:
            type: string
        - name: table
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ReportMetricsRequest"
      responses:
        "204":
          description: Metrics accepted
        "401":
          description: Unauthorized
        "404":
          description: Table not found

  /v1/namespaces/{namespace}/tables/{table}/credentials:
    get:
      tags: [tables]
      summary: Load vended credentials for a table
      operationId: loadTableCredentials
      description: |
        Load storage credentials scoped to a specific table's data files.
        Use this endpoint when you need credentials to access table data
        but don't need the full table metadata.
        
        The credentials returned are:
        - Short-lived (typically 1 hour)
        - Scoped to minimum required permissions for the table
        - Specific to the storage location (S3, GCS, Azure)
        
        This endpoint requires credential vending to be configured on the server.
        Returns 406 if credential vending is not supported for the table's storage location.
      security:
        - api_key: []
        - bearer_auth: []
      parameters:
        - name: namespace
          in: path
          required: true
          schema:
            type: string
        - name: table
          in: path
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Vended storage credentials
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LoadCredentialsResponse"
        "401":
          description: Unauthorized
        "403":
          description: Access denied
        "404":
          description: Table not found
        "406":
          description: Credential vending not supported for this table's storage location

  /v1/transactions/commit:
    post:
      tags: [tables]
      summary: Commit changes to multiple tables atomically
      operationId: commitTransaction
      description: Atomically commit changes to multiple tables. If any commit fails, previously committed changes are rolled back.
      security:
        - api_key: []
        - bearer_auth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CommitTransactionRequest"
      responses:
        "204":
          description: Transaction committed
        "400":
          description: Invalid request
        "401":
          description: Unauthorized
        "409":
          description: Conflict during commit

  /health:
    get:
      tags: [health]
      summary: Health check
      operationId: health
      responses:
        "200":
          description: Service is healthy
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HealthResponse"

  /ready:
    get:
      tags: [health]
      summary: Readiness check
      operationId: ready
      responses:
        "200":
          description: Service is ready
        "503":
          description: Service is not ready

  /metrics:
    get:
      tags: [metrics]
      summary: Prometheus metrics
      operationId: metrics
      responses:
        "200":
          description: Prometheus metrics in text format
          content:
            text/plain:
              schema:
                type: string

  /auth/context:
    get:
      tags: [auth]
      summary: Get authentication context
      description: |
        Returns the authenticated principal's identity and capabilities.
        Useful for CLI tools, SDKs, and UIs to understand what operations
        are available to the current user.
      operationId: getAuthContext
      security:
        - api_key: []
        - bearer_auth: []
      responses:
        "200":
          description: Authentication context
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AuthContextResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"

  /v1/search:
    get:
      tags: [search]
      summary: Search for tables and namespaces
      description: |
        Search for tables and namespaces across the catalog using substring matching.
        Results are filtered based on the authenticated principal's permissions -
        users only see objects they have at least Read access to.
        
        This endpoint is useful for:
        - CLI tools discovering available data
        - Web UIs presenting searchable catalogs
        - Data governance and discovery workflows
      operationId: search
      security:
        - api_key: []
        - bearer_auth: []
      parameters:
        - name: query
          in: query
          description: Search string for substring matching on names. Empty returns all accessible objects.
          schema:
            type: string
            default: ""
        - name: objectType
          in: query
          description: Filter by object type
          schema:
            type: string
            enum: [table, namespace, all]
            default: all
        - name: limit
          in: query
          description: Maximum number of results (1-1000)
          schema:
            type: integer
            minimum: 1
            maximum: 1000
            default: 100
        - name: recursive
          in: query
          description: Include child namespaces in search
          schema:
            type: boolean
            default: true
        - name: namespace
          in: query
          description: Filter to a specific namespace (dot-separated)
          schema:
            type: string
      responses:
        "200":
          description: Search results
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"

components:
  securitySchemes:
    api_key:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key authentication
    bearer_auth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT/OIDC authentication

  schemas:
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
            type:
              type: string
            code:
              type: integer

    AuthContextResponse:
      type: object
      description: Authentication context with principal info and capabilities
      required: [principal, capabilities]
      properties:
        principal:
          type: object
          description: Information about the authenticated principal
          required: [id, name, principal_type, tenant_id, roles, auth_method]
          properties:
            id:
              type: string
              description: Unique identifier for the principal
            name:
              type: string
              description: Human-readable display name
            principal_type:
              type: string
              enum: [user, service, api_key, system, anonymous]
              description: Type of principal
            tenant_id:
              type: string
              description: Tenant ID for multi-tenancy isolation
            roles:
              type: array
              items:
                type: string
              description: Roles assigned to this principal
            auth_method:
              type: string
              enum: [api_key, jwt, mtls, basic, internal, none]
              description: Authentication method used
            expires_at:
              type: string
              format: date-time
              description: When the authentication expires (ISO 8601)
        capabilities:
          type: object
          description: Capabilities the principal has for various resource types
          required: [catalog, namespaces, tables, is_admin]
          properties:
            catalog:
              $ref: "#/components/schemas/ActionSet"
            namespaces:
              $ref: "#/components/schemas/ActionSet"
            tables:
              $ref: "#/components/schemas/ActionSet"
            is_admin:
              type: boolean
              description: Whether the principal has admin privileges
        features:
          type: object
          additionalProperties:
            type: boolean
          description: Server-side feature flags

    ActionSet:
      type: object
      description: Set of allowed actions for a resource type
      properties:
        list:
          type: boolean
        read:
          type: boolean
        create:
          type: boolean
        update:
          type: boolean
        delete:
          type: boolean
        manage:
          type: boolean

    SearchResponse:
      type: object
      description: Search results with pagination info
      required: [results, totalCount, hasMore]
      properties:
        results:
          type: array
          items:
            $ref: "#/components/schemas/SearchResult"
        totalCount:
          type: integer
          description: Total matching results (before limit applied)
        hasMore:
          type: boolean
          description: Whether more results exist beyond the limit

    SearchResult:
      type: object
      description: A single search result (table or namespace)
      required: [objectType, qualifiedName, name, namespace]
      properties:
        objectType:
          type: string
          enum: [table, namespace]
          description: Type of the object
        qualifiedName:
          type: string
          description: Fully qualified name (e.g., "production.sales.orders")
        name:
          type: string
          description: Object name (last component)
        namespace:
          type: array
          items:
            type: string
          description: Parent namespace path
        description:
          type: string
          description: Brief description from object properties
        updatedAt:
          type: string
          format: date-time
          description: Last modification timestamp

    ConfigResponse:
      type: object
      properties:
        defaults:
          type: object
          additionalProperties:
            type: string
        overrides:
          type: object
          additionalProperties:
            type: string

    NamespaceResponse:
      type: object
      required: [namespace]
      properties:
        namespace:
          type: array
          items:
            type: string
        properties:
          type: object
          additionalProperties:
            type: string

    ListNamespacesResponse:
      type: object
      required: [namespaces]
      properties:
        namespaces:
          type: array
          items:
            type: array
            items:
              type: string
        next-page-token:
          type: string

    CreateNamespaceRequest:
      type: object
      required: [namespace]
      properties:
        namespace:
          type: array
          items:
            type: string
        properties:
          type: object
          additionalProperties:
            type: string

    UpdateNamespaceRequest:
      type: object
      properties:
        removals:
          type: array
          items:
            type: string
        updates:
          type: object
          additionalProperties:
            type: string

    UpdateNamespaceResponse:
      type: object
      properties:
        updated:
          type: array
          items:
            type: string
        removed:
          type: array
          items:
            type: string
        missing:
          type: array
          items:
            type: string

    ListTablesResponse:
      type: object
      required: [identifiers]
      properties:
        identifiers:
          type: array
          items:
            $ref: "#/components/schemas/TableIdentifier"
        next-page-token:
          type: string

    TableIdentifier:
      type: object
      required: [namespace, name]
      properties:
        namespace:
          type: array
          items:
            type: string
        name:
          type: string

    CreateTableRequest:
      type: object
      required: [name, schema]
      properties:
        name:
          type: string
        schema:
          type: object
          description: Iceberg table schema
        partition-spec:
          type: object
          description: Partition specification
        write-order:
          type: object
          description: Sort order for writes
        location:
          type: string
          description: Custom table location
        properties:
          type: object
          additionalProperties:
            type: string

    LoadTableResponse:
      type: object
      required: [metadata-location, metadata]
      properties:
        metadata-location:
          type: string
        metadata:
          type: object
          description: Full table metadata
        config:
          type: object
          additionalProperties:
            type: string
          description: Storage configuration with credentials
        storage-credentials:
          type: array
          description: Vended storage credentials for table data access
          items:
            $ref: "#/components/schemas/StorageCredential"

    LoadCredentialsResponse:
      type: object
      required: [storage-credentials]
      description: Response containing vended storage credentials for table data access
      properties:
        storage-credentials:
          type: array
          items:
            $ref: "#/components/schemas/StorageCredential"

    StorageCredential:
      type: object
      required: [prefix, config]
      description: |
        A vended storage credential with a prefix indicating where it applies.
        Clients should select the credential with the longest matching prefix.
      properties:
        prefix:
          type: string
          description: Storage location prefix where this credential is valid (e.g., "s3://bucket/prefix/")
        config:
          type: object
          additionalProperties:
            type: string
          description: |
            Configuration map containing the actual credentials.
            For S3: s3.access-key-id, s3.secret-access-key, s3.session-token
            For GCS: gcs.oauth2.token
            For Azure: adls.sas-token.<account>

    CommitTableRequest:
      type: object
      required: [requirements, updates]
      properties:
        requirements:
          type: array
          items:
            type: object
        updates:
          type: array
          items:
            type: object

    CommitTableResponse:
      type: object
      required: [metadata-location, metadata]
      properties:
        metadata-location:
          type: string
        metadata:
          type: object

    RenameTableRequest:
      type: object
      required: [source, destination]
      properties:
        source:
          $ref: "#/components/schemas/TableIdentifier"
        destination:
          $ref: "#/components/schemas/TableIdentifier"

    RegisterTableRequest:
      type: object
      required: [name, metadata-location]
      properties:
        name:
          type: string
          description: Name of the table to register
        metadata-location:
          type: string
          description: Location of the table metadata JSON file

    ReportMetricsRequest:
      type: object
      required: [report-type, table-name, snapshot-id]
      properties:
        report-type:
          type: string
          enum: [scan-report, commit-report]
          description: Type of metrics report
        table-name:
          type: string
          description: Fully qualified table name
        snapshot-id:
          type: integer
          format: int64
          description: Snapshot ID associated with the operation
        sequence-number:
          type: integer
          format: int64
          description: Sequence number (for commit reports)
        operation:
          type: string
          description: Operation type (append, overwrite, etc.)
        filter:
          type: object
          description: Filter expression (for scan reports)
        schema-id:
          type: integer
          description: Schema ID (for scan reports)
        projected-field-ids:
          type: array
          items:
            type: integer
          description: Projected field IDs
        projected-field-names:
          type: array
          items:
            type: string
          description: Projected field names
        metrics:
          type: object
          additionalProperties: true
          description: Metrics data
        metadata:
          type: object
          additionalProperties:
            type: string
          description: Additional metadata

    CommitTransactionRequest:
      type: object
      required: [table-changes]
      properties:
        table-changes:
          type: array
          items:
            $ref: "#/components/schemas/CommitTableRequest"
          description: List of table commits to apply atomically

    HealthResponse:
      type: object
      required: [status]
      properties:
        status:
          type: string
          enum: [healthy, unhealthy]
        components:
          type: object
          additionalProperties:
            type: string
"##;

// ============================================================================
// OpenAPI Spec Structures (for JSON output)
// ============================================================================

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct OpenApiSpec {
    pub openapi: String,
    pub info: Info,
    pub servers: Vec<Server>,
    pub tags: Vec<Tag>,
    pub paths: HashMap<String, PathItem>,
    pub components: Components,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Info {
    pub title: String,
    pub version: String,
    pub description: String,
    pub license: License,
    pub contact: Contact,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct License {
    pub name: String,
    pub url: String,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Contact {
    pub name: String,
    pub url: String,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Server {
    pub url: String,
    pub description: String,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Tag {
    pub name: String,
    pub description: String,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PathItem {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub get: Option<Operation>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub post: Option<Operation>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub put: Option<Operation>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub delete: Option<Operation>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Operation {
    pub tags: Vec<String>,
    pub summary: String,
    #[serde(rename = "operationId")]
    pub operation_id: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub parameters: Option<Vec<Parameter>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub request_body: Option<RequestBody>,
    pub responses: HashMap<String, Response>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Parameter {
    pub name: String,
    #[serde(rename = "in")]
    pub location: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub required: Option<bool>,
    pub schema: Schema,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RequestBody {
    pub required: bool,
    pub content: HashMap<String, MediaType>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct MediaType {
    pub schema: Schema,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Response {
    pub description: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub content: Option<HashMap<String, MediaType>>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Schema {
    #[serde(rename = "type", skip_serializing_if = "Option::is_none")]
    pub schema_type: Option<String>,
    #[serde(rename = "$ref", skip_serializing_if = "Option::is_none")]
    pub reference: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Components {
    #[serde(rename = "securitySchemes")]
    pub security_schemes: HashMap<String, SecurityScheme>,
    pub schemas: HashMap<String, serde_json::Value>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SecurityScheme {
    #[serde(rename = "type")]
    pub scheme_type: String,
    #[serde(rename = "in", skip_serializing_if = "Option::is_none")]
    pub location: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub scheme: Option<String>,
    #[serde(rename = "bearerFormat", skip_serializing_if = "Option::is_none")]
    pub bearer_format: Option<String>,
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_openapi_json_generation() {
        let json = ApiDoc::json();
        assert!(json.contains("Rustberg"));
        assert!(json.contains("Apache Iceberg"));
    }

    #[test]
    fn test_openapi_yaml_generation() {
        let yaml = ApiDoc::yaml();
        assert!(yaml.contains("Rustberg"));
        assert!(yaml.contains("/v1/namespaces"));
        assert!(yaml.contains("/v1/config"));
        assert!(yaml.contains("api_key"));
        assert!(!yaml.contains("{{VERSION}}")); // Version should be replaced
    }
}