Repository navigation
Expand file tree
/
Copy pathopenapi.json
More file actions
8988 lines (8988 loc) · 281 KB
/
Copy pathopenapi.json
File metadata and controls
8988 lines (8988 loc) · 281 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.1.0",
"info": {
"title": "Callora API",
"version": "1.0.0",
"description": "API contract covering Callora backend billing, usage, and developer routes."
},
"paths": {
"/api/vault/balance": {
"get": {
"summary": "Get the authenticated user's vault balance",
"operationId": "getVaultBalance",
"description": "Returns the latest cached balance snapshot. Snapshots older than VAULT_SNAPSHOT_MAX_AGE_MS are refreshed from the read-only vault contract; if Soroban RPC is unavailable, the previous value is returned with stale=true.",
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "network",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"testnet",
"mainnet"
]
},
"description": "Stellar network. Defaults to the configured active network."
}
],
"responses": {
"200": {
"description": "Vault balance snapshot",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success",
"data",
"requestId",
"timestamp"
],
"properties": {
"success": {
"type": "boolean",
"const": true
},
"data": {
"type": "object",
"required": [
"balance_usdc",
"contractId",
"network",
"lastSyncedAt",
"stale"
],
"properties": {
"balance_usdc": {
"type": "string",
"pattern": "^-?\\d+\\.\\d{7}$"
},
"contractId": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"testnet",
"mainnet"
]
},
"lastSyncedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"stale": {
"type": "boolean"
}
}
},
"requestId": {
"type": "string"
},
"timestamp": {
"type": "string",
"format": "date-time"
}
}
}
}
}
},
"401": {
"description": "Authentication is required",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "The caller has no vault on the requested network",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/vault/onchain": {
"get": {
"summary": "Read live on-chain vault state",
"operationId": "getOnchainVaultState",
"description": "Simulates the vault's read-only view functions and returns their values at the indicated ledger. In DEMO_MODE, requests without authentication read the configured testnet vault.",
"security": [
{},
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "network",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"testnet",
"mainnet"
]
},
"description": "Stellar network. Defaults to the configured active network."
}
],
"responses": {
"200": {
"description": "Live on-chain vault state",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success",
"data",
"requestId",
"timestamp"
],
"properties": {
"success": {
"type": "boolean",
"const": true
},
"data": {
"type": "object",
"required": [
"contractId",
"network",
"balanceUsdc",
"maxDeductUsdc",
"paused",
"usdcToken",
"settlement",
"ledger"
],
"properties": {
"contractId": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"testnet",
"mainnet"
]
},
"balanceUsdc": {
"type": "string",
"pattern": "^-?\\d+\\.\\d{7}$"
},
"maxDeductUsdc": {
"type": "string",
"pattern": "^-?\\d+\\.\\d{7}$"
},
"paused": {
"type": "boolean"
},
"usdcToken": {
"type": "string"
},
"settlement": {
"type": "string"
},
"ledger": {
"type": "integer",
"minimum": 0
}
}
},
"requestId": {
"type": "string"
},
"timestamp": {
"type": "string",
"format": "date-time"
}
}
}
}
}
},
"401": {
"description": "Authentication is required outside the public demo mode",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "The caller has no vault on the requested network",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/admin/billing/credits/grant": {
"post": {
"summary": "Grant GrantFox FWC26 prepaid credits",
"description": "Adds prepaid USDC credits to a user account for the GrantFox FWC26 campaign. Requires admin authentication and the admin IP allowlist.",
"security": [
{
"adminApiKey": []
},
{
"bearerAuth": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"user_id",
"amount_usdc"
],
"properties": {
"user_id": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"amount_usdc": {
"type": "string",
"pattern": "^\\d+(?:\\.\\d{1,7})?$",
"description": "Positive USDC amount with at most seven fractional digits"
}
}
},
"example": {
"user_id": "user_123",
"amount_usdc": "25.50"
}
}
}
},
"responses": {
"201": {
"description": "Credits granted",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"user_id",
"amount_usdc",
"balance_usdc",
"campaign",
"updated_at"
],
"properties": {
"user_id": {
"type": "string"
},
"amount_usdc": {
"type": "string"
},
"balance_usdc": {
"type": "string"
},
"campaign": {
"type": "string",
"example": "GrantFox FWC26"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
}
}
}
}
}
}
},
"400": {
"description": "Invalid grant request"
},
"401": {
"description": "Unauthorized admin request"
},
"403": {
"description": "Forbidden by admin IP allowlist"
}
}
}
},
"/api/health": {
"get": {
"summary": "Application health check",
"description": "Returns the health status of the application and its dependencies (database, Soroban RPC, Horizon). Public endpoint — no authentication required.",
"tags": [
"Health"
],
"responses": {
"200": {
"description": "Application is healthy or partially degraded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HealthResponse"
},
"examples": {
"simpleOk": {
"summary": "Simple health check (no config)",
"value": {
"success": true,
"data": {
"status": "ok",
"service": "callora-backend"
},
"requestId": "req-mock-uuid",
"timestamp": "2026-07-25T10:00:00.000Z"
}
},
"fullOk": {
"summary": "Full health check — all dependencies healthy",
"value": {
"success": true,
"data": {
"status": "ok",
"version": "1.0.0",
"timestamp": "2026-07-25T10:00:00.000Z",
"checks": {
"api": "ok",
"database": "ok",
"soroban_rpc": "ok"
}
},
"requestId": "req-mock-uuid",
"timestamp": "2026-07-25T10:00:00.000Z"
}
},
"degraded": {
"summary": "Degraded — database slow, optional dep down",
"value": {
"success": true,
"data": {
"status": "degraded",
"version": "1.0.0",
"timestamp": "2026-07-25T10:00:00.000Z",
"checks": {
"api": "ok",
"database": "degraded",
"soroban_rpc": "down"
}
},
"requestId": "req-mock-uuid",
"timestamp": "2026-07-25T10:00:00.000Z"
}
}
}
}
}
},
"503": {
"description": "Application is down or health check failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"examples": {
"serviceUnavailable": {
"summary": "Health check failure",
"value": {
"code": "SERVICE_UNAVAILABLE",
"message": "Health check failed",
"requestId": "req-mock-uuid"
}
}
}
}
}
}
}
}
},
"/api/health/health": {
"get": {
"summary": "Health Dependency Probe",
"description": "A dependency-level health probe that enumerates configured external dependencies (database, Soroban RPC, Horizon) with individual status, response time, and sanitized error information.",
"tags": [
"Health"
],
"responses": {
"200": {
"description": "Dependencies are healthy or partially degraded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HealthResponse"
}
}
}
},
"503": {
"description": "Dependencies are down or probe failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/rate-limit/health": {
"get": {
"summary": "Check rate-limit subsystem health",
"description": "Returns the operational status of the rate-limit subsystem and its configured dependencies. This public probe does not consume rate-limit budget and does not require a request body.",
"responses": {
"200": {
"description": "Rate-limit subsystem is operational",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RateLimitHealthResponse"
},
"examples": {
"operational": {
"summary": "In-memory limiter is operational",
"value": {
"status": "ok",
"timestamp": "2026-07-28T10:00:00.000Z",
"dependencies": {
"in_memory_store": {
"status": "ok",
"responseTime": 0.123,
"details": {
"windowMs": 60000,
"maxRequests": 100
}
}
}
}
},
"notConfigured": {
"summary": "No limiter configured",
"value": {
"status": "ok",
"timestamp": "2026-07-28T10:00:00.000Z",
"dependencies": {
"in_memory_store": {
"status": "ok",
"details": {
"note": "No rate limiter configured for probing"
}
}
}
}
}
}
}
}
},
"503": {
"description": "Rate-limit subsystem is unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RateLimitHealthResponse"
},
"examples": {
"unavailable": {
"summary": "Rate-limit store probe failed",
"value": {
"status": "down",
"timestamp": "2026-07-28T10:00:00.000Z",
"dependencies": {
"in_memory_store": {
"status": "down",
"responseTime": 0.456,
"error": "unavailable"
}
}
}
}
}
}
}
}
}
}
},
"/api/limits/check": {
"get": {
"summary": "Check the authenticated user's rate-limit budget",
"description": "Peeks at the authenticated user's REST rate-limit bucket without consuming a token. No request body is required.",
"security": [
{
"bearerAuth": []
}
],
"responses": {
"200": {
"description": "Rate-limit budget status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RateLimitCheckResponse"
},
"examples": {
"allowed": {
"summary": "Requests are currently allowed",
"value": {
"status": "ok"
}
},
"denied": {
"summary": "Rate-limit budget is exhausted",
"value": {
"status": "deny",
"reason": "rate_limit_exceeded",
"retryAfterMs": 42300
}
}
}
}
}
},
"401": {
"description": "Authentication is required",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"examples": {
"unauthorized": {
"summary": "Missing or invalid authentication",
"value": {
"code": "UNAUTHORIZED",
"message": "Authentication required",
"requestId": "req-rate-limit-check"
}
}
}
}
}
}
}
}
},
"/api/gateway/health/{apiSlug}": {
"get": {
"summary": "Get gateway health for an API",
"description": "Returns aggregated upstream latency percentiles and circuit breaker state for a given API slug. Public endpoint — no authentication required. Only aggregated metrics are returned; no tenant identifiers or raw histogram data are exposed. Results are cached in-memory for 5 seconds.",
"parameters": [
{
"name": "apiSlug",
"in": "path",
"required": true,
"description": "The API slug to query health for",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Health data retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GatewayHealthResponse"
}
}
}
},
"404": {
"description": "API slug not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/billing/deduct": {
"post": {
"summary": "Deduct billing balance for an API call",
"description": "Deducts USDC from the user's vault balance to pay for an API call. Authenticated and idempotent.",
"externalDocs": {
"description": "SDK idempotency contract and retry guidance",
"url": "https://callora.com/sdk/billing-deduct.md"
},
"security": [
{
"bearerAuth": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BillingDeductRequest"
},
"examples": {
"deductRequest": {
"summary": "Deduct billing request",
"value": {
"requestId": "req-123e4567-e89b-12d3-a456-426614174000",
"developerId": "dev-123",
"apiId": "api-123",
"endpointId": "endpoint-456",
"apiKeyId": "key-789",
"amountUsdc": "0.01",
"idempotencyKey": "idem-abc123"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Billing deduction successfully processed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BillingDeductResponse"
},
"examples": {
"success": {
"summary": "Successful deduction",
"value": {
"success": true,
"usageEventId": "evt-123e4567-e89b-12d3-a456-426614174000",
"stellarTxHash": "abc123def456...",
"alreadyProcessed": false
}
},
"alreadyProcessed": {
"summary": "Already processed (idempotent)",
"value": {
"success": true,
"usageEventId": "evt-123e4567-e89b-12d3-a456-426614174000",
"stellarTxHash": "abc123def456...",
"alreadyProcessed": true
}
}
}
}
}
},
"400": {
"description": "Invalid request body parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"examples": {
"invalidAmount": {
"summary": "Invalid amount format",
"value": {
"code": "BAD_REQUEST",
"message": "amountUsdc must be a positive number with at most 7 decimal places",
"requestId": "req-abc123"
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"examples": {
"unauthorized": {
"summary": "Missing or invalid authentication",
"value": {
"code": "UNAUTHORIZED",
"message": "Authentication required",
"requestId": "req-abc123"
}
}
}
}
}
},
"402": {
"description": "Payment required (insufficient balance)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"examples": {
"insufficientBalance": {
"summary": "Insufficient balance",
"value": {
"code": "INSUFFICIENT_BALANCE",
"message": "Vault balance too low for deduction",
"requestId": "req-abc123"
}
}
}
}
}
},
"409": {
"description": "Conflict or reconciliation required",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"examples": {
"idempotencyConflict": {
"summary": "Idempotency key already used with different parameters",
"value": {
"code": "IDEMPOTENCY_CONFLICT",
"message": "Idempotency key conflict: different request parameters",
"requestId": "req-abc123"
}
},
"reconciliationRequired": {
"summary": "Previous deduction attempt pending reconciliation",
"value": {
"success": false,
"error": {
"code": "RECONCILIATION_REQUIRED",
"message": "Billing deduction pending reconciliation"
},
"reconciliationRequired": true,
"deductionStatus": "pending",
"usageEventId": "evt-123",
"requestId": "req-abc123",
"timestamp": "2026-07-28T10:00:00.000Z"
}
}
}
}
}
}
}
}
},
"/api/billing/deduct/bulk": {
"post": {
"summary": "Deduct billing balance for up to 100 API calls in one batch",
"description": "Creates usage events for up to 100 billing entries in a single database transaction, then performs one aggregate on-chain deduction for the newly inserted entries. Existing requestIds are treated idempotently and are returned in the per-entry results without being charged again.",
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "Idempotency-Key",
"in": "header",
"required": false,
"schema": {
"type": "string"
},
"description": "Optional key for replaying the complete batch response."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BillingBulkDeductRequest"
}
}
}
},
"responses": {
"200": {
"description": "Bulk billing deduction successfully processed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BillingBulkDeductResponse"
}
}
}
},
"400": {
"description": "Invalid batch or duplicate requestId",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BillingBulkDeductErrorResponse"
}
}
}
},
"402": {
"description": "Aggregate balance is insufficient; no new usage events are charged",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"409": {
"description": "Idempotency key conflict or deduction requires reconciliation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BillingBulkDeductErrorResponse"
}
}
}
},
"429": {
"description": "Rate limit exceeded",
"headers": {
"Retry-After": {
"schema": {
"type": "integer",
"description": "Seconds until the rate limit expires"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"examples": {
"rateLimited": {
"summary": "Too many requests",
"value": {
"code": "TOO_MANY_REQUESTS",
"message": "Too Many Requests",
"requestId": "req-abc123"
}
}
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/usage": {
"get": {
"summary": "Retrieve user API usage and stats",
"description": "Returns the authenticated user's API call events, aggregated stats, and time breakdown.",
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "from",
"in": "query",
"description": "Start of period (ISO-8601 string)",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "to",
"in": "query",
"description": "End of period (ISO-8601 string)",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "limit",
"in": "query",
"description": "Number of usage events to return",
"required": false,
"schema": {
"type": "integer",
"default": 20
}
},
{
"name": "offset",
"in": "query",
"description": "Pagination offset",
"required": false,
"schema": {
"type": "integer",
"default": 0
}
},
{
"name": "apiId",
"in": "query",
"description": "Filter by specific API ID",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "groupBy",
"in": "query",
"description": "Aggregation bucket size",
"required": false,
"schema": {
"type": "string",
"enum": [
"day",
"week",
"month"
]
}
}
],
"responses": {
"200": {
"description": "Usage events and analytics retrieved successfully",
"content": {
"application/json": {
"schema": {