-
Notifications
You must be signed in to change notification settings - Fork 114
/
Copy pathv1.yaml
1885 lines (1833 loc) · 51.3 KB
/
v1.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
title: Ledger API
contact: {}
version: v1
paths:
/_info:
get:
tags:
- ledger.v1
summary: Show server information
operationId: getInfo
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigInfoResponse'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- Authorization:
- ledger:read
/{ledger}/_info:
get:
summary: Get information about a ledger
operationId: getLedgerInfo
tags:
- ledger.v1
parameters:
- name: ledger
in: path
description: Name of the ledger.
required: true
schema:
type: string
example: ledger001
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/LedgerInfoResponse'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- Authorization:
- ledger:read
/{ledger}/accounts:
head:
summary: Count the accounts from a ledger
operationId: countAccounts
tags:
- ledger.v1
parameters:
- name: ledger
in: path
description: Name of the ledger.
required: true
schema:
type: string
example: ledger001
- name: address
in: query
description: >-
Filter accounts by address pattern (regular expression placed
between ^ and $).
schema:
type: string
example: users:.+
- name: metadata
in: query
description: >-
Filter accounts by metadata key value pairs. The filter can be used
like this metadata[key]=value1&metadata[a.nested.key]=value2
style: deepObject
explode: true
schema:
type: object
additionalProperties: true
example: metadata[key]=value1&metadata[a.nested.key]=value2
responses:
'200':
description: OK
headers:
Count:
schema:
type: integer
format: int64
minimum: 0
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- Authorization:
- ledger:read
get:
summary: List accounts from a ledger
description: List accounts from a ledger, sorted by address in descending order.
operationId: listAccounts
tags:
- ledger.v1
parameters:
- name: ledger
in: path
description: Name of the ledger.
required: true
schema:
type: string
example: ledger001
- name: pageSize
in: query
description: |
The maximum number of results to return per page.
example: 100
schema:
type: integer
format: int64
minimum: 1
maximum: 1000
- name: page_size
x-speakeasy-ignore: true
in: query
description: |
The maximum number of results to return per page.
Deprecated, please use `pageSize` instead.
example: 100
schema:
type: integer
format: int64
minimum: 1
maximum: 1000
deprecated: true
- name: after
in: query
description: >-
Pagination cursor, will return accounts after given address, in
descending order.
schema:
type: string
example: users:003
- name: address
in: query
description: >-
Filter accounts by address pattern (regular expression placed
between ^ and $).
schema:
type: string
example: users:.+
- name: metadata
in: query
description: >-
Filter accounts by metadata key value pairs. Nested objects can be
used as seen in the example below.
style: deepObject
explode: true
schema:
type: object
additionalProperties: true
example: metadata[key]=value1&metadata[a.nested.key]=value2
- name: balance
in: query
description: Filter accounts by their balance (default operator is gte)
schema:
type: integer
format: int64
example: 2400
- name: balanceOperator
x-speakeasy-ignore: true
in: query
description: >
Operator used for the filtering of balances can be greater
than/equal, less than/equal, greater than, less than, equal or not.
schema:
type: string
enum:
- gte
- lte
- gt
- lt
- e
- ne
example: gte
- name: balance_operator
x-speakeasy-ignore: true
in: query
description: >
Operator used for the filtering of balances can be greater
than/equal, less than/equal, greater than, less than, equal or not.
Deprecated, please use `balanceOperator` instead.
schema:
type: string
enum:
- gte
- lte
- gt
- lt
- e
- ne
example: gte
deprecated: true
- name: cursor
in: query
description: >
Parameter used in pagination requests. Maximum page size is set to
1000.
Set to the value of next for the next page of results.
Set to the value of previous for the previous page of results.
No other parameters can be set when this parameter is set.
schema:
type: string
example: aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==
- name: pagination_token
in: query
description: >
Parameter used in pagination requests. Maximum page size is set to
1000.
Set to the value of next for the next page of results.
Set to the value of previous for the previous page of results.
No other parameters can be set when this parameter is set.
Deprecated, please use `cursor` instead.
schema:
type: string
example: aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==
deprecated: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AccountsCursorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- Authorization:
- ledger:read
/{ledger}/accounts/{address}:
get:
summary: Get account by its address
operationId: getAccount
tags:
- ledger.v1
parameters:
- name: ledger
in: path
description: Name of the ledger.
required: true
schema:
type: string
example: ledger001
- name: address
in: path
description: >
Exact address of the account. It must match the following regular
expressions pattern:
```
^\w+(:\w+)*$
```
required: true
schema:
type: string
example: users:001
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AccountResponse'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- Authorization:
- ledger:read
/{ledger}/accounts/{address}/metadata:
post:
summary: Add metadata to an account
operationId: addMetadataToAccount
tags:
- ledger.v1
parameters:
- name: ledger
in: path
description: Name of the ledger.
required: true
schema:
type: string
example: ledger001
- name: address
in: path
description: >
Exact address of the account. It must match the following regular
expressions pattern:
```
^\w+(:\w+)*$
```
required: true
schema:
type: string
example: users:001
requestBody:
description: metadata
content:
application/json:
schema:
$ref: '#/components/schemas/Metadata'
required: true
responses:
'204':
description: No Content
content: {}
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- Authorization:
- ledger:write
/{ledger}/mapping:
get:
tags:
- ledger.v1
operationId: getMapping
summary: Get the mapping of a ledger
parameters:
- name: ledger
in: path
description: Name of the ledger.
required: true
schema:
type: string
example: ledger001
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MappingResponse'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- Authorization:
- ledger:read
put:
tags:
- ledger.v1
operationId: updateMapping
summary: Update the mapping of a ledger
parameters:
- name: ledger
in: path
description: Name of the ledger.
required: true
schema:
type: string
example: ledger001
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Mapping'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MappingResponse'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- Authorization:
- ledger:write
/{ledger}/script:
post:
deprecated: true
tags:
- ledger.v1
operationId: runScript
summary: Execute a Numscript
description: >
This route is deprecated, and has been merged into `POST
/{ledger}/transactions`.
parameters:
- name: ledger
in: path
description: Name of the ledger.
required: true
schema:
type: string
example: ledger001
- name: preview
in: query
description: >-
Set the preview mode. Preview mode doesn't add the logs to the
database or publish a message to the message broker.
schema:
type: boolean
example: true
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Script'
responses:
'200':
description: >
On success, it will return a 200 status code, and the resulting
transaction under the `transaction` field.
On failure, it will also return a 200 status code, and the following
fields:
- `details`: contains a URL. When there is an error parsing Numscript, the result can be difficult to read—the provided URL will render the error in an easy-to-read format.
- `errorCode` and `error_code` (deprecated): contains the string code of the error
- `errorMessage` and `error_message` (deprecated): contains a human-readable indication of what went wrong, for example that an account had insufficient funds, or that there was an error in the provided Numscript.
content:
application/json:
schema:
$ref: '#/components/schemas/ScriptResponse'
security:
- Authorization:
- ledger:write
/{ledger}/stats:
get:
tags:
- ledger.v1
operationId: readStats
summary: Get statistics from a ledger
description: >
Get statistics from a ledger. (aggregate metrics on accounts and
transactions)
parameters:
- name: ledger
in: path
description: name of the ledger
required: true
schema:
type: string
example: ledger001
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/StatsResponse'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- Authorization:
- ledger:read
/{ledger}/transactions:
head:
tags:
- ledger.v1
summary: Count the transactions from a ledger
operationId: countTransactions
parameters:
- name: ledger
in: path
description: Name of the ledger.
required: true
schema:
type: string
example: ledger001
- name: reference
in: query
description: Filter transactions by reference field.
schema:
type: string
example: ref:001
- name: account
in: query
description: >-
Filter transactions with postings involving given account, either as
source or destination (regular expression placed between ^ and $).
schema:
type: string
example: users:001
- name: source
in: query
description: >-
Filter transactions with postings involving given account at source
(regular expression placed between ^ and $).
schema:
type: string
example: users:001
- name: destination
in: query
description: >-
Filter transactions with postings involving given account at
destination (regular expression placed between ^ and $).
schema:
type: string
example: users:001
- name: startTime
in: query
description: >
Filter transactions that occurred after this timestamp.
The format is RFC3339 and is inclusive (for example,
"2023-01-02T15:04:01Z" includes the first second of 4th minute).
schema:
type: string
format: date-time
- name: start_time
x-speakeasy-ignore: true
in: query
description: >
Filter transactions that occurred after this timestamp.
The format is RFC3339 and is inclusive (for example,
"2023-01-02T15:04:01Z" includes the first second of 4th minute).
Deprecated, please use `startTime` instead.
schema:
type: string
format: date-time
deprecated: true
- name: endTime
in: query
description: >
Filter transactions that occurred before this timestamp.
The format is RFC3339 and is exclusive (for example,
"2023-01-02T15:04:01Z" excludes the first second of 4th minute).
schema:
type: string
format: date-time
- name: end_time
x-speakeasy-ignore: true
in: query
description: >
Filter transactions that occurred before this timestamp.
The format is RFC3339 and is exclusive (for example,
"2023-01-02T15:04:01Z" excludes the first second of 4th minute).
Deprecated, please use `endTime` instead.
schema:
type: string
format: date-time
deprecated: true
- name: metadata
in: query
description: >-
Filter transactions by metadata key value pairs. Nested objects can
be used as seen in the example below.
style: deepObject
explode: true
schema:
type: object
properties: {}
example: metadata[key]=value1&metadata[a.nested.key]=value2
responses:
'200':
description: OK
headers:
Count:
schema:
type: integer
format: int64
minimum: 0
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- Authorization:
- ledger:read
get:
tags:
- ledger.v1
summary: List transactions from a ledger
description: List transactions from a ledger, sorted by txid in descending order.
operationId: listTransactions
parameters:
- name: ledger
in: path
description: Name of the ledger.
required: true
schema:
type: string
example: ledger001
- name: pageSize
in: query
description: |
The maximum number of results to return per page.
example: 100
schema:
type: integer
format: int64
minimum: 1
maximum: 1000
- name: page_size
x-speakeasy-ignore: true
in: query
description: |
The maximum number of results to return per page.
Deprecated, please use `pageSize` instead.
example: 100
schema:
type: integer
format: int64
minimum: 1
maximum: 1000
deprecated: true
- name: after
in: query
description: >-
Pagination cursor, will return transactions after given txid (in
descending order).
schema:
type: string
example: 1234
- name: reference
in: query
description: Find transactions by reference field.
schema:
type: string
example: ref:001
- name: account
in: query
description: >-
Filter transactions with postings involving given account, either as
source or destination (regular expression placed between ^ and $).
schema:
type: string
example: users:001
- name: source
in: query
description: >-
Filter transactions with postings involving given account at source
(regular expression placed between ^ and $).
schema:
type: string
example: users:001
- name: destination
in: query
description: >-
Filter transactions with postings involving given account at
destination (regular expression placed between ^ and $).
schema:
type: string
example: users:001
- name: startTime
in: query
description: >
Filter transactions that occurred after this timestamp.
The format is RFC3339 and is inclusive (for example,
"2023-01-02T15:04:01Z" includes the first second of 4th minute).
schema:
type: string
format: date-time
- name: start_time
x-speakeasy-ignore: true
in: query
description: >
Filter transactions that occurred after this timestamp.
The format is RFC3339 and is inclusive (for example,
"2023-01-02T15:04:01Z" includes the first second of 4th minute).
Deprecated, please use `startTime` instead.
schema:
type: string
format: date-time
deprecated: true
- name: endTime
in: query
description: >
Filter transactions that occurred before this timestamp.
The format is RFC3339 and is exclusive (for example,
"2023-01-02T15:04:01Z" excludes the first second of 4th minute).
schema:
type: string
format: date-time
- name: end_time
x-speakeasy-ignore: true
in: query
description: >
Filter transactions that occurred before this timestamp.
The format is RFC3339 and is exclusive (for example,
"2023-01-02T15:04:01Z" excludes the first second of 4th minute).
Deprecated, please use `endTime` instead.
schema:
type: string
format: date-time
deprecated: true
- name: cursor
in: query
description: >
Parameter used in pagination requests. Maximum page size is set to
1000.
Set to the value of next for the next page of results.
Set to the value of previous for the previous page of results.
No other parameters can be set when this parameter is set.
schema:
type: string
example: aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==
- name: pagination_token
x-speakeasy-ignore: true
in: query
description: >
Parameter used in pagination requests. Maximum page size is set to
1000.
Set to the value of next for the next page of results.
Set to the value of previous for the previous page of results.
No other parameters can be set when this parameter is set.
Deprecated, please use `cursor` instead.
schema:
type: string
example: aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==
deprecated: true
- name: metadata
in: query
description: >-
Filter transactions by metadata key value pairs. Nested objects can
be used as seen in the example below.
style: deepObject
explode: true
schema:
type: object
additionalProperties: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionsCursorResponse'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- Authorization:
- ledger:read
post:
tags:
- ledger.v1
summary: Create a new transaction to a ledger
operationId: createTransaction
parameters:
- name: ledger
in: path
description: Name of the ledger.
required: true
schema:
type: string
example: ledger001
- name: preview
in: query
description: >-
Set the preview mode. Preview mode doesn't add the logs to the
database or publish a message to the message broker.
schema:
type: boolean
example: true
requestBody:
required: true
description: |
The request body must contain at least one of the following objects:
- `postings`: suitable for simple transactions
- `script`: enabling more complex transactions with Numscript
content:
application/json:
schema:
$ref: '#/components/schemas/PostTransaction'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionsResponse'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- Authorization:
- ledger:write
/{ledger}/transactions/{txid}:
get:
tags:
- ledger.v1
summary: Get transaction from a ledger by its ID
operationId: getTransaction
parameters:
- name: ledger
in: path
description: Name of the ledger.
required: true
schema:
type: string
example: ledger001
- name: txid
in: path
description: Transaction ID.
required: true
schema:
type: integer
format: bigint
minimum: 0
example: 1234
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionResponse'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- Authorization:
- ledger:read
/{ledger}/transactions/{txid}/metadata:
post:
tags:
- ledger.v1
summary: Set the metadata of a transaction by its ID
operationId: addMetadataOnTransaction
parameters:
- name: ledger
in: path
description: Name of the ledger.
required: true
schema:
type: string
example: ledger001
- name: txid
in: path
description: Transaction ID.
required: true
schema:
type: integer
format: bigint
minimum: 0
example: 1234
requestBody:
required: true
description: metadata
content:
application/json:
schema:
$ref: '#/components/schemas/Metadata'
responses:
'204':
description: No Content
content: {}
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- Authorization:
- ledger:write
/{ledger}/transactions/{txid}/revert:
post:
tags:
- ledger.v1
operationId: revertTransaction
summary: Revert a ledger transaction by its ID
parameters:
- name: ledger
in: path
description: Name of the ledger.
required: true
schema:
type: string
example: ledger001
- name: txid
in: path
description: Transaction ID.
required: true
schema:
type: integer
format: bigint
minimum: 0
example: 1234
- name: disableChecks
in: query
description: Allow to disable balances checks
required: false
schema:
type: boolean
responses:
'201':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionResponse'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- Authorization:
- ledger:write
/{ledger}/transactions/batch:
post:
tags:
- ledger.v1
summary: Create a new batch of transactions to a ledger
operationId: CreateTransactions
parameters:
- name: ledger
in: path
description: Name of the ledger.
required: true
schema:
type: string