@n1xyz/nord-ts 0.7.0 → 0.7.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/actions.d.ts +1 -2
- package/dist/client/NordAdmin.d.ts +36 -0
- package/dist/gen/nord_pb.d.ts +912 -4
- package/dist/gen/openapi.d.ts +741 -346
- package/dist/index.browser.js +18611 -12822
- package/dist/index.common.js +14805 -8646
- package/dist/index.d.ts +1 -1
- package/package.json +1 -1
package/dist/gen/openapi.d.ts
CHANGED
|
@@ -105,9 +105,11 @@ export interface paths {
|
|
|
105
105
|
path?: never;
|
|
106
106
|
cookie?: never;
|
|
107
107
|
};
|
|
108
|
-
/**
|
|
108
|
+
/**
|
|
109
|
+
* @description UNSTABLE: operational health endpoint for history catchup progress.
|
|
109
110
|
*
|
|
110
|
-
* Returns 503 on any partial degradation. Do not use as a liveness probe.
|
|
111
|
+
* Returns 503 on any partial degradation. Do not use as a liveness probe.
|
|
112
|
+
*/
|
|
111
113
|
get: {
|
|
112
114
|
parameters: {
|
|
113
115
|
query?: never;
|
|
@@ -311,10 +313,12 @@ export interface paths {
|
|
|
311
313
|
};
|
|
312
314
|
};
|
|
313
315
|
put?: never;
|
|
314
|
-
/**
|
|
316
|
+
/**
|
|
317
|
+
* @description Send an action to nord to execute.
|
|
315
318
|
* This doesn't use `Protobuf<T>` since we want to length-delimit this message.
|
|
316
319
|
* `body` - (length prefix of action, action data protobuf, and signature). signature has exact length, but depend on action kind.
|
|
317
|
-
* body is exact payload used via other transports and journalled for rexecution
|
|
320
|
+
* body is exact payload used via other transports and journalled for rexecution
|
|
321
|
+
*/
|
|
318
322
|
post: {
|
|
319
323
|
parameters: {
|
|
320
324
|
query?: never;
|
|
@@ -428,9 +432,6 @@ export interface paths {
|
|
|
428
432
|
};
|
|
429
433
|
requestBody?: never;
|
|
430
434
|
responses: {
|
|
431
|
-
/** @description Non negative time in seconds (oracle precision).
|
|
432
|
-
* In production within engine determinsitic code,
|
|
433
|
-
* this time can only go forward and cannot be `Default`. */
|
|
434
435
|
200: {
|
|
435
436
|
headers: {
|
|
436
437
|
[name: string]: unknown;
|
|
@@ -456,8 +457,10 @@ export interface paths {
|
|
|
456
457
|
path?: never;
|
|
457
458
|
cookie?: never;
|
|
458
459
|
};
|
|
459
|
-
/**
|
|
460
|
-
*
|
|
460
|
+
/**
|
|
461
|
+
* @description The last acknowledged event nonce. Use this to ascertain if a given
|
|
462
|
+
* withdrawal was processed by nord.
|
|
463
|
+
*/
|
|
461
464
|
get: {
|
|
462
465
|
parameters: {
|
|
463
466
|
query?: never;
|
|
@@ -498,8 +501,10 @@ export interface paths {
|
|
|
498
501
|
query?: never;
|
|
499
502
|
header?: never;
|
|
500
503
|
path: {
|
|
501
|
-
/**
|
|
502
|
-
*
|
|
504
|
+
/**
|
|
505
|
+
* @description where `streams` is `trades@{symbol} | deltas@{symbol} | account@{account id} | candle@{symbol}:{resolution} [&, ...]`
|
|
506
|
+
* e.g. `/ws/trades@BTCUSDC&deltas@BTCUSDC&account@42&candle@BTCUSDC:60`
|
|
507
|
+
*/
|
|
503
508
|
streams: string;
|
|
504
509
|
};
|
|
505
510
|
cookie?: never;
|
|
@@ -763,10 +768,12 @@ export interface paths {
|
|
|
763
768
|
path?: never;
|
|
764
769
|
cookie?: never;
|
|
765
770
|
};
|
|
766
|
-
/**
|
|
771
|
+
/**
|
|
772
|
+
* @description If protocol is healthy, it will be some amount expressed in USDC unit, like 1 USDC or 0.1 USDC.
|
|
767
773
|
* For example if 1 ETH is 10_000 USDC price, and fee 1 USDC, that means that user will get 0.9999 ETH instead of 1 ETH.
|
|
768
774
|
*
|
|
769
|
-
* If protocol in unhealthy, withdrawal fee will be proportional to protocol debt.
|
|
775
|
+
* If protocol in unhealthy, withdrawal fee will be proportional to protocol debt.
|
|
776
|
+
*/
|
|
770
777
|
get: {
|
|
771
778
|
parameters: {
|
|
772
779
|
query?: never;
|
|
@@ -981,10 +988,12 @@ export interface paths {
|
|
|
981
988
|
};
|
|
982
989
|
requestBody?: never;
|
|
983
990
|
responses: {
|
|
984
|
-
/**
|
|
991
|
+
/**
|
|
992
|
+
* @description Owner share and withdrawal state
|
|
985
993
|
*
|
|
986
994
|
* Withdrawals are owner side `Q_owner,current`, `Q_owner,previous`, and
|
|
987
|
-
* `Q_owner,claimable`
|
|
995
|
+
* `Q_owner,claimable`
|
|
996
|
+
*/
|
|
988
997
|
200: {
|
|
989
998
|
headers: {
|
|
990
999
|
[name: string]: unknown;
|
|
@@ -1599,8 +1608,10 @@ export interface paths {
|
|
|
1599
1608
|
};
|
|
1600
1609
|
requestBody?: never;
|
|
1601
1610
|
responses: {
|
|
1602
|
-
/**
|
|
1603
|
-
*
|
|
1611
|
+
/**
|
|
1612
|
+
* @description Solana base58 address with private key (must have private side so that can create session after).
|
|
1613
|
+
* Basically fix for solana-pubkey is array of bytes in serde https://github.com/anza-xyz/solana-sdk/pull/76
|
|
1614
|
+
*/
|
|
1604
1615
|
200: {
|
|
1605
1616
|
headers: {
|
|
1606
1617
|
[name: string]: unknown;
|
|
@@ -1634,8 +1645,10 @@ export interface paths {
|
|
|
1634
1645
|
path?: never;
|
|
1635
1646
|
cookie?: never;
|
|
1636
1647
|
};
|
|
1637
|
-
/**
|
|
1638
|
-
*
|
|
1648
|
+
/**
|
|
1649
|
+
* @description Given order identifier, return order summary.
|
|
1650
|
+
* Works for order which were immediately filled, partially filled, cancelled or fully filled.
|
|
1651
|
+
*/
|
|
1639
1652
|
get: {
|
|
1640
1653
|
parameters: {
|
|
1641
1654
|
query?: never;
|
|
@@ -1647,8 +1660,10 @@ export interface paths {
|
|
|
1647
1660
|
};
|
|
1648
1661
|
requestBody?: never;
|
|
1649
1662
|
responses: {
|
|
1650
|
-
/**
|
|
1651
|
-
*
|
|
1663
|
+
/**
|
|
1664
|
+
* @description Order summary.
|
|
1665
|
+
* Use order_id to application side join with trades as needed.
|
|
1666
|
+
*/
|
|
1652
1667
|
200: {
|
|
1653
1668
|
headers: {
|
|
1654
1669
|
[name: string]: unknown;
|
|
@@ -1724,7 +1739,8 @@ export interface paths {
|
|
|
1724
1739
|
path?: never;
|
|
1725
1740
|
cookie?: never;
|
|
1726
1741
|
};
|
|
1727
|
-
/**
|
|
1742
|
+
/**
|
|
1743
|
+
* @description Ordered from present to past.
|
|
1728
1744
|
*
|
|
1729
1745
|
* Pagination
|
|
1730
1746
|
* Besides set of trades in `trades` array, endpoint returns `accountId` and actual values for `since` and `until`
|
|
@@ -1733,7 +1749,8 @@ export interface paths {
|
|
|
1733
1749
|
* To fetch it, client should pass `since` and `until` returned and add `nextStartInclusive`'s value as `startInclusive` parameter.
|
|
1734
1750
|
* By default, `startInclusive` and `nextStartInclusive` are trade ids. When `paginationMode=actionId`,
|
|
1735
1751
|
* they are action ids, and `pageSize` counts distinct action ids instead of individual trade rows.
|
|
1736
|
-
* If `nextStartInclusive` is absent, it means there's no more data to fetch, even if 50 entries were returned.
|
|
1752
|
+
* If `nextStartInclusive` is absent, it means there's no more data to fetch, even if 50 entries were returned.
|
|
1753
|
+
*/
|
|
1737
1754
|
get: {
|
|
1738
1755
|
parameters: {
|
|
1739
1756
|
query?: {
|
|
@@ -1782,7 +1799,8 @@ export interface paths {
|
|
|
1782
1799
|
path?: never;
|
|
1783
1800
|
cookie?: never;
|
|
1784
1801
|
};
|
|
1785
|
-
/**
|
|
1802
|
+
/**
|
|
1803
|
+
* @description Returns state download link and metadata,
|
|
1786
1804
|
* as defined by nearest(up to equality) snapshot `time` or `action_id`` or `timestamp`.
|
|
1787
1805
|
* If not specified, returns latest snapshot.
|
|
1788
1806
|
* Example: /state/download?actionId=1
|
|
@@ -1791,7 +1809,8 @@ export interface paths {
|
|
|
1791
1809
|
* To get the latest snap use:
|
|
1792
1810
|
* /state/download - w/o any params.
|
|
1793
1811
|
*
|
|
1794
|
-
* The link from responce can be inserted to search bar in browser to download.
|
|
1812
|
+
* The link from responce can be inserted to search bar in browser to download.
|
|
1813
|
+
*/
|
|
1795
1814
|
get: {
|
|
1796
1815
|
parameters: {
|
|
1797
1816
|
query?: never;
|
|
@@ -1834,10 +1853,12 @@ export interface paths {
|
|
|
1834
1853
|
path?: never;
|
|
1835
1854
|
cookie?: never;
|
|
1836
1855
|
};
|
|
1837
|
-
/**
|
|
1856
|
+
/**
|
|
1857
|
+
* @description Typical HTTP file download endpoint.
|
|
1838
1858
|
* Actually same as provided by S3 storages.
|
|
1839
1859
|
* Means supports Range header, Content-Length, Content-Type, ETag and so on,
|
|
1840
|
-
* and relevant headers.
|
|
1860
|
+
* and relevant headers.
|
|
1861
|
+
*/
|
|
1841
1862
|
get: {
|
|
1842
1863
|
parameters: {
|
|
1843
1864
|
query?: never;
|
|
@@ -2107,12 +2128,14 @@ export interface paths {
|
|
|
2107
2128
|
path?: never;
|
|
2108
2129
|
cookie?: never;
|
|
2109
2130
|
};
|
|
2110
|
-
/**
|
|
2131
|
+
/**
|
|
2132
|
+
* @description Get trading volume for an account
|
|
2111
2133
|
*
|
|
2112
2134
|
* Optionally, you can specify a market to get volume for.
|
|
2113
2135
|
* If not specified, array of (MarketId, Volume) is returned.
|
|
2114
2136
|
*
|
|
2115
|
-
* Returns raw values, caller must rescale to base token decimals
|
|
2137
|
+
* Returns raw values, caller must rescale to base token decimals
|
|
2138
|
+
*/
|
|
2116
2139
|
get: {
|
|
2117
2140
|
parameters: {
|
|
2118
2141
|
query: {
|
|
@@ -2644,6 +2667,49 @@ export interface paths {
|
|
|
2644
2667
|
patch?: never;
|
|
2645
2668
|
trace?: never;
|
|
2646
2669
|
};
|
|
2670
|
+
"/account/claim-vault/history/transfer": {
|
|
2671
|
+
parameters: {
|
|
2672
|
+
query?: never;
|
|
2673
|
+
header?: never;
|
|
2674
|
+
path?: never;
|
|
2675
|
+
cookie?: never;
|
|
2676
|
+
};
|
|
2677
|
+
get: {
|
|
2678
|
+
parameters: {
|
|
2679
|
+
query?: {
|
|
2680
|
+
/** @description start with this timestamp (RFC3339); defaults to UNIX epoch start */
|
|
2681
|
+
since?: string;
|
|
2682
|
+
/** @description end with this timestamp (RFC3339); defaults to current date-time */
|
|
2683
|
+
until?: string;
|
|
2684
|
+
/** @description fetch results starting with this page; query starts with first entry if page isn't specified */
|
|
2685
|
+
startInclusive?: number;
|
|
2686
|
+
/** @description Query returns up to 50 trades in one go. */
|
|
2687
|
+
pageSize?: number;
|
|
2688
|
+
};
|
|
2689
|
+
header?: never;
|
|
2690
|
+
path?: never;
|
|
2691
|
+
cookie?: never;
|
|
2692
|
+
};
|
|
2693
|
+
requestBody?: never;
|
|
2694
|
+
responses: {
|
|
2695
|
+
200: {
|
|
2696
|
+
headers: {
|
|
2697
|
+
[name: string]: unknown;
|
|
2698
|
+
};
|
|
2699
|
+
content: {
|
|
2700
|
+
"application/json": components["schemas"]["PageResult_for_uint64_and_TransferRow"];
|
|
2701
|
+
};
|
|
2702
|
+
};
|
|
2703
|
+
};
|
|
2704
|
+
};
|
|
2705
|
+
put?: never;
|
|
2706
|
+
post?: never;
|
|
2707
|
+
delete?: never;
|
|
2708
|
+
options?: never;
|
|
2709
|
+
head?: never;
|
|
2710
|
+
patch?: never;
|
|
2711
|
+
trace?: never;
|
|
2712
|
+
};
|
|
2647
2713
|
"/account/{account_id}/history/liquidation": {
|
|
2648
2714
|
parameters: {
|
|
2649
2715
|
query?: never;
|
|
@@ -2734,6 +2800,40 @@ export interface paths {
|
|
|
2734
2800
|
patch?: never;
|
|
2735
2801
|
trace?: never;
|
|
2736
2802
|
};
|
|
2803
|
+
"/account/claim-vault": {
|
|
2804
|
+
parameters: {
|
|
2805
|
+
query?: never;
|
|
2806
|
+
header?: never;
|
|
2807
|
+
path?: never;
|
|
2808
|
+
cookie?: never;
|
|
2809
|
+
};
|
|
2810
|
+
get: {
|
|
2811
|
+
parameters: {
|
|
2812
|
+
query?: never;
|
|
2813
|
+
header?: never;
|
|
2814
|
+
path?: never;
|
|
2815
|
+
cookie?: never;
|
|
2816
|
+
};
|
|
2817
|
+
requestBody?: never;
|
|
2818
|
+
responses: {
|
|
2819
|
+
200: {
|
|
2820
|
+
headers: {
|
|
2821
|
+
[name: string]: unknown;
|
|
2822
|
+
};
|
|
2823
|
+
content: {
|
|
2824
|
+
"application/json": components["schemas"]["Balance"][];
|
|
2825
|
+
};
|
|
2826
|
+
};
|
|
2827
|
+
};
|
|
2828
|
+
};
|
|
2829
|
+
put?: never;
|
|
2830
|
+
post?: never;
|
|
2831
|
+
delete?: never;
|
|
2832
|
+
options?: never;
|
|
2833
|
+
head?: never;
|
|
2834
|
+
patch?: never;
|
|
2835
|
+
trace?: never;
|
|
2836
|
+
};
|
|
2737
2837
|
"/accounts/liquidations/takes": {
|
|
2738
2838
|
parameters: {
|
|
2739
2839
|
query?: never;
|
|
@@ -2811,8 +2911,10 @@ export interface paths {
|
|
|
2811
2911
|
path?: never;
|
|
2812
2912
|
cookie?: never;
|
|
2813
2913
|
};
|
|
2814
|
-
/**
|
|
2815
|
-
*
|
|
2914
|
+
/**
|
|
2915
|
+
* @description Gets market updates history for some period of time.
|
|
2916
|
+
* Default is hourly for last 24 hours
|
|
2917
|
+
*/
|
|
2816
2918
|
get: {
|
|
2817
2919
|
parameters: {
|
|
2818
2920
|
query?: {
|
|
@@ -2859,74 +2961,94 @@ export interface components {
|
|
|
2859
2961
|
schemas: {
|
|
2860
2962
|
OpenApi: {
|
|
2861
2963
|
openapi: string;
|
|
2862
|
-
/**
|
|
2863
|
-
*
|
|
2964
|
+
/**
|
|
2965
|
+
* @description REQUIRED. Provides metadata about the API.
|
|
2966
|
+
* The metadata MAY be used by tooling as required.
|
|
2967
|
+
*/
|
|
2864
2968
|
info: components["schemas"]["Info"];
|
|
2865
|
-
/**
|
|
2866
|
-
*
|
|
2969
|
+
/**
|
|
2970
|
+
* @description The default value for the `$schema` keyword within Schema Objects
|
|
2971
|
+
* contained within this OAS document. This MUST be in the form of a URI.
|
|
2972
|
+
*/
|
|
2867
2973
|
jsonSchemaDialect?: string | null;
|
|
2868
|
-
/**
|
|
2974
|
+
/**
|
|
2975
|
+
* @description An array of Server Objects, which provide connectivity information to a
|
|
2869
2976
|
* target server. If the servers property is not provided, or is an empty
|
|
2870
|
-
* array, the default value would be a Server Object with a url value of /.
|
|
2977
|
+
* array, the default value would be a Server Object with a url value of /.
|
|
2978
|
+
*/
|
|
2871
2979
|
servers?: components["schemas"]["Server"][];
|
|
2872
2980
|
/** @description The available paths and operations for the API. */
|
|
2873
2981
|
paths?: components["schemas"]["Paths"] | null;
|
|
2874
|
-
/**
|
|
2982
|
+
/**
|
|
2983
|
+
* @description The incoming webhooks that MAY be received as part of this API and that
|
|
2875
2984
|
* the API consumer MAY choose to implement. Closely related to the
|
|
2876
2985
|
* `callbacks` feature, this section describes requests initiated other
|
|
2877
2986
|
* than by an API call, for example by an out of band registration. The key
|
|
2878
2987
|
* name is a unique string to refer to each webhook, while the (optionally
|
|
2879
2988
|
* referenced) Path Item Object describes a request that may be initiated
|
|
2880
|
-
* by the API provider and the expected responses.
|
|
2989
|
+
* by the API provider and the expected responses.
|
|
2990
|
+
*/
|
|
2881
2991
|
webhooks?: {
|
|
2882
2992
|
[key: string]: components["schemas"]["ReferenceOr"];
|
|
2883
2993
|
};
|
|
2884
2994
|
/** @description An element to hold various schemas for the document. */
|
|
2885
2995
|
components?: components["schemas"]["Components"] | null;
|
|
2886
|
-
/**
|
|
2996
|
+
/**
|
|
2997
|
+
* @description A declaration of which security mechanisms can be used across the API.
|
|
2887
2998
|
*
|
|
2888
2999
|
* The list of values includes alternative security requirement objects
|
|
2889
3000
|
* that can be used. Only one of the security requirement objects need to
|
|
2890
3001
|
* be satisfied to authorize a request. Individual operations can override
|
|
2891
3002
|
* this definition. Global security settings may be overridden on a
|
|
2892
|
-
* per-path basis.
|
|
3003
|
+
* per-path basis.
|
|
3004
|
+
*/
|
|
2893
3005
|
security?: {
|
|
2894
3006
|
[key: string]: string[];
|
|
2895
3007
|
}[];
|
|
2896
|
-
/**
|
|
3008
|
+
/**
|
|
3009
|
+
* @description A list of tags used by the document with additional metadata.
|
|
2897
3010
|
*
|
|
2898
3011
|
* The order of the tags can be used to reflect on their order by the
|
|
2899
3012
|
* parsing tools. Not all tags that are used by the Operation Object
|
|
2900
3013
|
* must be declared. The tags that are not declared MAY be organized
|
|
2901
3014
|
* randomly or based on the tool's logic. Each tag name in the list
|
|
2902
|
-
* MUST be unique.
|
|
3015
|
+
* MUST be unique.
|
|
3016
|
+
*/
|
|
2903
3017
|
tags?: components["schemas"]["Tag"][];
|
|
2904
3018
|
/** @description Additional external documentation. */
|
|
2905
3019
|
externalDocs?: components["schemas"]["ExternalDocumentation"] | null;
|
|
2906
3020
|
} & {
|
|
2907
3021
|
[key: string]: unknown;
|
|
2908
3022
|
};
|
|
2909
|
-
/**
|
|
3023
|
+
/**
|
|
3024
|
+
* @description The object provides metadata about the API.
|
|
2910
3025
|
* The metadata MAY be used by the clients if needed,
|
|
2911
3026
|
* and MAY be presented in editing or documentation generation tools for
|
|
2912
|
-
* convenience.
|
|
3027
|
+
* convenience.
|
|
3028
|
+
*/
|
|
2913
3029
|
Info: {
|
|
2914
3030
|
/** @description REQUIRED. The title of the application. */
|
|
2915
3031
|
title: string;
|
|
2916
3032
|
/** @description A short summary of the API. */
|
|
2917
3033
|
summary?: string | null;
|
|
2918
|
-
/**
|
|
2919
|
-
*
|
|
3034
|
+
/**
|
|
3035
|
+
* @description A description of the API.
|
|
3036
|
+
* CommonMark syntax MAY be used for rich text representation.
|
|
3037
|
+
*/
|
|
2920
3038
|
description?: string | null;
|
|
2921
|
-
/**
|
|
2922
|
-
*
|
|
3039
|
+
/**
|
|
3040
|
+
* @description A URL to the Terms of Service for the API.
|
|
3041
|
+
* This MUST be in the format of a URL.
|
|
3042
|
+
*/
|
|
2923
3043
|
termsOfService?: string | null;
|
|
2924
3044
|
/** @description The contact information for the exposed API. */
|
|
2925
3045
|
contact?: components["schemas"]["Contact"] | null;
|
|
2926
3046
|
/** @description The license information for the exposed API. */
|
|
2927
3047
|
license?: components["schemas"]["License"] | null;
|
|
2928
|
-
/**
|
|
2929
|
-
*
|
|
3048
|
+
/**
|
|
3049
|
+
* @description REQUIRED. The version of the OpenAPI document (which is distinct from
|
|
3050
|
+
* the OpenAPI Specification version or the API implementation version).
|
|
3051
|
+
*/
|
|
2930
3052
|
version: string;
|
|
2931
3053
|
} & {
|
|
2932
3054
|
[key: string]: unknown;
|
|
@@ -2935,11 +3057,15 @@ export interface components {
|
|
|
2935
3057
|
Contact: {
|
|
2936
3058
|
/** @description The identifying name of the contact person/organization. */
|
|
2937
3059
|
name?: string | null;
|
|
2938
|
-
/**
|
|
2939
|
-
*
|
|
3060
|
+
/**
|
|
3061
|
+
* @description The URL pointing to the contact information.
|
|
3062
|
+
* This MUST be in the format of a URL.
|
|
3063
|
+
*/
|
|
2940
3064
|
url?: string | null;
|
|
2941
|
-
/**
|
|
2942
|
-
*
|
|
3065
|
+
/**
|
|
3066
|
+
* @description The email address of the contact person/organization.
|
|
3067
|
+
* This MUST be in the format of an email address.
|
|
3068
|
+
*/
|
|
2943
3069
|
email?: string | null;
|
|
2944
3070
|
} & {
|
|
2945
3071
|
[key: string]: unknown;
|
|
@@ -2950,89 +3076,121 @@ export interface components {
|
|
|
2950
3076
|
name: string;
|
|
2951
3077
|
/** @description An [SPDX](https://spdx.org/spdx-specification-21-web-version#h.jxpfx0ykyb60) license expression for the API. The `identifier` field is mutually exclusive of the `url` field. */
|
|
2952
3078
|
identifier?: string | null;
|
|
2953
|
-
/**
|
|
2954
|
-
*
|
|
3079
|
+
/**
|
|
3080
|
+
* @description A URL to the license used for the API. This MUST be in the form of a
|
|
3081
|
+
* URL. The `url` field is mutually exclusive of the `identifier` field.
|
|
3082
|
+
*/
|
|
2955
3083
|
url?: string | null;
|
|
2956
3084
|
} & {
|
|
2957
3085
|
[key: string]: unknown;
|
|
2958
3086
|
};
|
|
2959
3087
|
/** @description An object representing a Server. */
|
|
2960
3088
|
Server: {
|
|
2961
|
-
/**
|
|
3089
|
+
/**
|
|
3090
|
+
* @description REQUIRED. A URL to the target host.
|
|
2962
3091
|
* This URL supports Server Variables and MAY be relative,
|
|
2963
3092
|
* to indicate that the host location is relative to the
|
|
2964
3093
|
* location where the OpenAPI document is being served.
|
|
2965
3094
|
* Variable substitutions will be made when a variable
|
|
2966
|
-
* is named in {brackets}.
|
|
3095
|
+
* is named in {brackets}.
|
|
3096
|
+
*/
|
|
2967
3097
|
url: string;
|
|
2968
|
-
/**
|
|
3098
|
+
/**
|
|
3099
|
+
* @description An optional string describing the host designated
|
|
2969
3100
|
* by the URL. CommonMark syntax MAY be used for rich
|
|
2970
|
-
* text representation.
|
|
3101
|
+
* text representation.
|
|
3102
|
+
*/
|
|
2971
3103
|
description?: string | null;
|
|
2972
|
-
/**
|
|
2973
|
-
*
|
|
3104
|
+
/**
|
|
3105
|
+
* @description A map between a variable name and its value.
|
|
3106
|
+
* The value is used for substitution in the server's URL template.
|
|
3107
|
+
*/
|
|
2974
3108
|
variables?: {
|
|
2975
3109
|
[key: string]: components["schemas"]["ServerVariable"];
|
|
2976
3110
|
};
|
|
2977
3111
|
} & {
|
|
2978
3112
|
[key: string]: unknown;
|
|
2979
3113
|
};
|
|
2980
|
-
/**
|
|
2981
|
-
*
|
|
3114
|
+
/**
|
|
3115
|
+
* @description An object representing a Server Variable
|
|
3116
|
+
* for server URL template substitution.
|
|
3117
|
+
*/
|
|
2982
3118
|
ServerVariable: {
|
|
2983
|
-
/**
|
|
2984
|
-
*
|
|
3119
|
+
/**
|
|
3120
|
+
* @description An enumeration of string values to be
|
|
3121
|
+
* used if the substitution options are from a limited set.
|
|
3122
|
+
*/
|
|
2985
3123
|
enum?: string[];
|
|
2986
|
-
/**
|
|
3124
|
+
/**
|
|
3125
|
+
* @description REQUIRED. The default value to use for substitution,
|
|
2987
3126
|
* and to send, if an alternate value is not supplied.
|
|
2988
3127
|
* Unlike the Schema Object's default, this value MUST
|
|
2989
|
-
* be provided by the consumer.
|
|
3128
|
+
* be provided by the consumer.
|
|
3129
|
+
*/
|
|
2990
3130
|
default: string;
|
|
2991
|
-
/**
|
|
3131
|
+
/**
|
|
3132
|
+
* @description An optional description for the server
|
|
2992
3133
|
* variable. CommonMark syntax MAY be used
|
|
2993
|
-
* for rich text representation.
|
|
3134
|
+
* for rich text representation.
|
|
3135
|
+
*/
|
|
2994
3136
|
description?: string | null;
|
|
2995
3137
|
} & {
|
|
2996
3138
|
[key: string]: unknown;
|
|
2997
3139
|
};
|
|
2998
|
-
/**
|
|
3140
|
+
/**
|
|
3141
|
+
* @description Holds the relative paths to the individual endpoints and
|
|
2999
3142
|
* their operations. The path is appended to the URL from the
|
|
3000
3143
|
* Server Object in order to construct the full URL. The Paths
|
|
3001
|
-
* MAY be empty, due to Access Control List (ACL) constraints.
|
|
3144
|
+
* MAY be empty, due to Access Control List (ACL) constraints.
|
|
3145
|
+
*/
|
|
3002
3146
|
Paths: {
|
|
3003
3147
|
[key: string]: components["schemas"]["ReferenceOr"];
|
|
3004
3148
|
};
|
|
3005
3149
|
ReferenceOr: {
|
|
3006
|
-
/**
|
|
3007
|
-
*
|
|
3150
|
+
/**
|
|
3151
|
+
* @description REQUIRED. The reference identifier. This MUST be in the form of a
|
|
3152
|
+
* URI.
|
|
3153
|
+
*/
|
|
3008
3154
|
$ref: string;
|
|
3009
|
-
/**
|
|
3155
|
+
/**
|
|
3156
|
+
* @description A short summary which by default SHOULD override that of the
|
|
3010
3157
|
* referenced component. If the referenced object-type does not allow a
|
|
3011
|
-
* `summary` field, then this field has no effect.
|
|
3158
|
+
* `summary` field, then this field has no effect.
|
|
3159
|
+
*/
|
|
3012
3160
|
summary?: string | null;
|
|
3013
|
-
/**
|
|
3161
|
+
/**
|
|
3162
|
+
* @description A description which by default SHOULD override that of the
|
|
3014
3163
|
* referenced component. CommonMark syntax MAY be used for rich text
|
|
3015
3164
|
* representation. If the referenced object-type does not allow a
|
|
3016
|
-
* `description` field, then this field has no effect.
|
|
3165
|
+
* `description` field, then this field has no effect.
|
|
3166
|
+
*/
|
|
3017
3167
|
description?: string | null;
|
|
3018
3168
|
} | components["schemas"]["PathItem"];
|
|
3019
|
-
/**
|
|
3169
|
+
/**
|
|
3170
|
+
* @description Describes the operations available on a single path.
|
|
3020
3171
|
* A Path Item MAY be empty, due to ACL constraints.
|
|
3021
3172
|
* The path itself is still exposed to the documentation
|
|
3022
3173
|
* viewer but they will not know which operations and
|
|
3023
|
-
* parameters are available.
|
|
3174
|
+
* parameters are available.
|
|
3175
|
+
*/
|
|
3024
3176
|
PathItem: {
|
|
3025
|
-
/**
|
|
3177
|
+
/**
|
|
3178
|
+
* @description Allows for a referenced definition of this path item. The referenced
|
|
3026
3179
|
* structure MUST be in the form of a Path Item Object. In case a Path
|
|
3027
3180
|
* Item Object field appears both in the defined object and the referenced
|
|
3028
3181
|
* object, the behavior is undefined. See the rules for resolving Relative
|
|
3029
|
-
* References.
|
|
3182
|
+
* References.
|
|
3183
|
+
*/
|
|
3030
3184
|
$ref?: string | null;
|
|
3031
|
-
/**
|
|
3032
|
-
*
|
|
3185
|
+
/**
|
|
3186
|
+
* @description An optional, string summary, intended to apply to all operations in
|
|
3187
|
+
* this path.
|
|
3188
|
+
*/
|
|
3033
3189
|
summary?: string | null;
|
|
3034
|
-
/**
|
|
3035
|
-
*
|
|
3190
|
+
/**
|
|
3191
|
+
* @description An optional, string description, intended to apply to all operations in
|
|
3192
|
+
* this path. CommonMark syntax MAY be used for rich text representation.
|
|
3193
|
+
*/
|
|
3036
3194
|
description?: string | null;
|
|
3037
3195
|
get?: components["schemas"]["Operation"] | null;
|
|
3038
3196
|
put?: components["schemas"]["Operation"] | null;
|
|
@@ -3044,45 +3202,56 @@ export interface components {
|
|
|
3044
3202
|
trace?: components["schemas"]["Operation"] | null;
|
|
3045
3203
|
/** @description An alternative server array to service all operations in this path. */
|
|
3046
3204
|
servers?: components["schemas"]["Server"][];
|
|
3047
|
-
/**
|
|
3205
|
+
/**
|
|
3206
|
+
* @description A list of parameters that are applicable for all the
|
|
3048
3207
|
* operations described under this path. These parameters
|
|
3049
3208
|
* can be overridden at the operation level, but cannot be
|
|
3050
3209
|
* removed there. The list MUST NOT include duplicated parameters.
|
|
3051
3210
|
* A unique parameter is defined by a combination of a name and location.
|
|
3052
3211
|
* The list can use the Reference Object to link to parameters that
|
|
3053
|
-
* are defined at the OpenAPI Object's components/parameters.
|
|
3212
|
+
* are defined at the OpenAPI Object's components/parameters.
|
|
3213
|
+
*/
|
|
3054
3214
|
parameters?: components["schemas"]["ReferenceOr2"][];
|
|
3055
3215
|
} & {
|
|
3056
3216
|
[key: string]: unknown;
|
|
3057
3217
|
};
|
|
3058
3218
|
/** @description Describes a single API operation on a path. */
|
|
3059
3219
|
Operation: {
|
|
3060
|
-
/**
|
|
3220
|
+
/**
|
|
3221
|
+
* @description A list of tags for API documentation control.
|
|
3061
3222
|
* Tags can be used for logical grouping of operations
|
|
3062
|
-
* by resources or any other qualifier.
|
|
3223
|
+
* by resources or any other qualifier.
|
|
3224
|
+
*/
|
|
3063
3225
|
tags?: string[];
|
|
3064
3226
|
/** @description A short summary of what the operation does. */
|
|
3065
3227
|
summary?: string | null;
|
|
3066
|
-
/**
|
|
3067
|
-
*
|
|
3228
|
+
/**
|
|
3229
|
+
* @description A verbose explanation of the operation behavior.
|
|
3230
|
+
* CommonMark syntax MAY be used for rich text representation.
|
|
3231
|
+
*/
|
|
3068
3232
|
description?: string | null;
|
|
3069
3233
|
/** @description Additional external documentation for this operation. */
|
|
3070
3234
|
externalDocs?: components["schemas"]["ExternalDocumentation"] | null;
|
|
3071
|
-
/**
|
|
3235
|
+
/**
|
|
3236
|
+
* @description Unique string used to identify the operation.
|
|
3072
3237
|
* The id MUST be unique among all operations described in the API.
|
|
3073
3238
|
* Tools and libraries MAY use the operationId to uniquely identify
|
|
3074
3239
|
* an operation, therefore, it is RECOMMENDED to follow common
|
|
3075
|
-
* programming naming conventions.
|
|
3240
|
+
* programming naming conventions.
|
|
3241
|
+
*/
|
|
3076
3242
|
operationId?: string | null;
|
|
3077
|
-
/**
|
|
3243
|
+
/**
|
|
3244
|
+
* @description A list of parameters that are applicable for this operation.
|
|
3078
3245
|
* If a parameter is already defined at the Path Item, the new
|
|
3079
3246
|
* definition will override it but can never remove it.
|
|
3080
3247
|
* The list MUST NOT include duplicated parameters. A unique
|
|
3081
3248
|
* parameter is defined by a combination of a name and location.
|
|
3082
3249
|
* The list can use the Reference Object to link to parameters
|
|
3083
|
-
* that are defined at the OpenAPI Object's components/parameters.
|
|
3250
|
+
* that are defined at the OpenAPI Object's components/parameters.
|
|
3251
|
+
*/
|
|
3084
3252
|
parameters?: components["schemas"]["ReferenceOr2"][];
|
|
3085
|
-
/**
|
|
3253
|
+
/**
|
|
3254
|
+
* @description The request body applicable for this operation.
|
|
3086
3255
|
* The requestBody is fully supported in HTTP methods
|
|
3087
3256
|
* where the HTTP 1.1 specification RFC7231 has explicitly
|
|
3088
3257
|
* defined semantics for request bodies. In other cases where
|
|
@@ -3091,25 +3260,32 @@ export interface components {
|
|
|
3091
3260
|
* [HEAD](https://tools.ietf.org/html/rfc7231#section-4.3.2) and
|
|
3092
3261
|
* [DELETE](https://tools.ietf.org/html/rfc7231#section-4.3.5)),
|
|
3093
3262
|
* requestBody is permitted but does not have well-defined semantics and
|
|
3094
|
-
* SHOULD be avoided if possible.
|
|
3263
|
+
* SHOULD be avoided if possible.
|
|
3264
|
+
*/
|
|
3095
3265
|
requestBody?: components["schemas"]["ReferenceOr5"] | null;
|
|
3096
|
-
/**
|
|
3097
|
-
*
|
|
3266
|
+
/**
|
|
3267
|
+
* @description The list of possible responses as they are returned
|
|
3268
|
+
* from executing this operation.
|
|
3269
|
+
*/
|
|
3098
3270
|
responses?: components["schemas"]["Responses"] | null;
|
|
3099
3271
|
/** @description Declares this operation to be deprecated.Default value is false. */
|
|
3100
3272
|
deprecated?: boolean;
|
|
3101
|
-
/**
|
|
3273
|
+
/**
|
|
3274
|
+
* @description A declaration of which security mechanisms can be used for this
|
|
3102
3275
|
* operation. The list of values includes alternative security
|
|
3103
3276
|
* requirement objects that can be used. Only one of the security
|
|
3104
3277
|
* requirement objects need to be satisfied to authorize a request.
|
|
3105
3278
|
* This definition overrides any declared top-level security. To remove
|
|
3106
|
-
* a top-level security declaration, an empty array can be used.
|
|
3279
|
+
* a top-level security declaration, an empty array can be used.
|
|
3280
|
+
*/
|
|
3107
3281
|
security?: {
|
|
3108
3282
|
[key: string]: string[];
|
|
3109
3283
|
}[];
|
|
3110
|
-
/**
|
|
3284
|
+
/**
|
|
3285
|
+
* @description An alternative server array to service this operation.
|
|
3111
3286
|
* If an alternative server object is specified at the
|
|
3112
|
-
* Path Item Object or Root level, it will be overridden by this value.
|
|
3287
|
+
* Path Item Object or Root level, it will be overridden by this value.
|
|
3288
|
+
*/
|
|
3113
3289
|
servers?: components["schemas"]["Server"][];
|
|
3114
3290
|
/** @description Callbacks for the operation. */
|
|
3115
3291
|
callbacks?: {
|
|
@@ -3120,31 +3296,42 @@ export interface components {
|
|
|
3120
3296
|
};
|
|
3121
3297
|
/** @description Allows referencing an external resource for extended documentation. */
|
|
3122
3298
|
ExternalDocumentation: {
|
|
3123
|
-
/**
|
|
3124
|
-
*
|
|
3299
|
+
/**
|
|
3300
|
+
* @description A description of the target documentation.
|
|
3301
|
+
* CommonMark syntax MAY be used for rich text representation.
|
|
3302
|
+
*/
|
|
3125
3303
|
description?: string | null;
|
|
3126
|
-
/**
|
|
3127
|
-
*
|
|
3304
|
+
/**
|
|
3305
|
+
* @description REQUIRED. The URL for the target documentation.
|
|
3306
|
+
* This MUST be in the format of a URL.
|
|
3307
|
+
*/
|
|
3128
3308
|
url: string;
|
|
3129
3309
|
} & {
|
|
3130
3310
|
[key: string]: unknown;
|
|
3131
3311
|
};
|
|
3132
3312
|
ReferenceOr2: {
|
|
3133
|
-
/**
|
|
3134
|
-
*
|
|
3313
|
+
/**
|
|
3314
|
+
* @description REQUIRED. The reference identifier. This MUST be in the form of a
|
|
3315
|
+
* URI.
|
|
3316
|
+
*/
|
|
3135
3317
|
$ref: string;
|
|
3136
|
-
/**
|
|
3318
|
+
/**
|
|
3319
|
+
* @description A short summary which by default SHOULD override that of the
|
|
3137
3320
|
* referenced component. If the referenced object-type does not allow a
|
|
3138
|
-
* `summary` field, then this field has no effect.
|
|
3321
|
+
* `summary` field, then this field has no effect.
|
|
3322
|
+
*/
|
|
3139
3323
|
summary?: string | null;
|
|
3140
|
-
/**
|
|
3324
|
+
/**
|
|
3325
|
+
* @description A description which by default SHOULD override that of the
|
|
3141
3326
|
* referenced component. CommonMark syntax MAY be used for rich text
|
|
3142
3327
|
* representation. If the referenced object-type does not allow a
|
|
3143
|
-
* `description` field, then this field has no effect.
|
|
3328
|
+
* `description` field, then this field has no effect.
|
|
3329
|
+
*/
|
|
3144
3330
|
description?: string | null;
|
|
3145
3331
|
} | components["schemas"]["Parameter"];
|
|
3146
3332
|
Parameter: (({
|
|
3147
|
-
/**
|
|
3333
|
+
/**
|
|
3334
|
+
* @description REQUIRED. The name of the parameter. Parameter names are case sensitive.
|
|
3148
3335
|
* If in is "path", the name field MUST correspond to the associated path
|
|
3149
3336
|
* segment from the path field in the Paths Object. See Path Templating for
|
|
3150
3337
|
* further information.
|
|
@@ -3153,41 +3340,54 @@ export interface components {
|
|
|
3153
3340
|
* "Authorization", the parameter definition SHALL be ignored.
|
|
3154
3341
|
*
|
|
3155
3342
|
* For all other cases, the name corresponds to the parameter name
|
|
3156
|
-
* used by the in property.
|
|
3343
|
+
* used by the in property.
|
|
3344
|
+
*/
|
|
3157
3345
|
name: string;
|
|
3158
|
-
/**
|
|
3346
|
+
/**
|
|
3347
|
+
* @description A brief description of the parameter. This could
|
|
3159
3348
|
* contain examples of use. CommonMark syntax MAY be
|
|
3160
|
-
* used for rich text representation.
|
|
3349
|
+
* used for rich text representation.
|
|
3350
|
+
*/
|
|
3161
3351
|
description?: string | null;
|
|
3162
|
-
/**
|
|
3352
|
+
/**
|
|
3353
|
+
* @description Determines whether this parameter is mandatory.
|
|
3163
3354
|
* If the parameter location is "path", this property
|
|
3164
3355
|
* is REQUIRED and its value MUST be true. Otherwise,
|
|
3165
3356
|
* the property MAY be included and its default value
|
|
3166
|
-
* is false.
|
|
3357
|
+
* is false.
|
|
3358
|
+
*/
|
|
3167
3359
|
required?: boolean;
|
|
3168
|
-
/**
|
|
3169
|
-
*
|
|
3360
|
+
/**
|
|
3361
|
+
* @description Specifies that a parameter is deprecated and SHOULD
|
|
3362
|
+
* be transitioned out of usage.
|
|
3363
|
+
*/
|
|
3170
3364
|
deprecated?: boolean | null;
|
|
3171
3365
|
example?: unknown;
|
|
3172
3366
|
examples?: {
|
|
3173
3367
|
[key: string]: components["schemas"]["ReferenceOr3"];
|
|
3174
3368
|
};
|
|
3175
3369
|
explode?: boolean | null;
|
|
3176
|
-
/**
|
|
3370
|
+
/**
|
|
3371
|
+
* @description Determines whether the parameter value SHOULD allow reserved
|
|
3177
3372
|
* characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included
|
|
3178
3373
|
* without percent-encoding. This property only applies to parameters
|
|
3179
|
-
* with an in value of query. The default value is false.
|
|
3374
|
+
* with an in value of query. The default value is false.
|
|
3375
|
+
*/
|
|
3180
3376
|
allow_reserved?: boolean;
|
|
3181
|
-
/**
|
|
3377
|
+
/**
|
|
3378
|
+
* @description Describes how the parameter value will be serialized depending on
|
|
3182
3379
|
* the type of the parameter value. Default values (based on value of
|
|
3183
3380
|
* in): for query - form; for path - simple; for header - simple; for
|
|
3184
|
-
* cookie - form.
|
|
3381
|
+
* cookie - form.
|
|
3382
|
+
*/
|
|
3185
3383
|
style?: components["schemas"]["QueryStyle"];
|
|
3186
|
-
/**
|
|
3384
|
+
/**
|
|
3385
|
+
* @description Sets the ability to pass empty-valued parameters. This is
|
|
3187
3386
|
* valid only for query parameters and allows sending a parameter
|
|
3188
3387
|
* with an empty value. Default value is false. If style is used,
|
|
3189
3388
|
* and if behavior is n/a (cannot be serialized), the value of
|
|
3190
|
-
* allowEmptyValue SHALL be ignored.
|
|
3389
|
+
* allowEmptyValue SHALL be ignored.
|
|
3390
|
+
*/
|
|
3191
3391
|
allow_empty_value?: boolean | null;
|
|
3192
3392
|
/** @constant */
|
|
3193
3393
|
in: "query";
|
|
@@ -3202,7 +3402,8 @@ export interface components {
|
|
|
3202
3402
|
[key: string]: components["schemas"]["MediaType"];
|
|
3203
3403
|
};
|
|
3204
3404
|
})) | (({
|
|
3205
|
-
/**
|
|
3405
|
+
/**
|
|
3406
|
+
* @description REQUIRED. The name of the parameter. Parameter names are case sensitive.
|
|
3206
3407
|
* If in is "path", the name field MUST correspond to the associated path
|
|
3207
3408
|
* segment from the path field in the Paths Object. See Path Templating for
|
|
3208
3409
|
* further information.
|
|
@@ -3211,30 +3412,39 @@ export interface components {
|
|
|
3211
3412
|
* "Authorization", the parameter definition SHALL be ignored.
|
|
3212
3413
|
*
|
|
3213
3414
|
* For all other cases, the name corresponds to the parameter name
|
|
3214
|
-
* used by the in property.
|
|
3415
|
+
* used by the in property.
|
|
3416
|
+
*/
|
|
3215
3417
|
name: string;
|
|
3216
|
-
/**
|
|
3418
|
+
/**
|
|
3419
|
+
* @description A brief description of the parameter. This could
|
|
3217
3420
|
* contain examples of use. CommonMark syntax MAY be
|
|
3218
|
-
* used for rich text representation.
|
|
3421
|
+
* used for rich text representation.
|
|
3422
|
+
*/
|
|
3219
3423
|
description?: string | null;
|
|
3220
|
-
/**
|
|
3424
|
+
/**
|
|
3425
|
+
* @description Determines whether this parameter is mandatory.
|
|
3221
3426
|
* If the parameter location is "path", this property
|
|
3222
3427
|
* is REQUIRED and its value MUST be true. Otherwise,
|
|
3223
3428
|
* the property MAY be included and its default value
|
|
3224
|
-
* is false.
|
|
3429
|
+
* is false.
|
|
3430
|
+
*/
|
|
3225
3431
|
required?: boolean;
|
|
3226
|
-
/**
|
|
3227
|
-
*
|
|
3432
|
+
/**
|
|
3433
|
+
* @description Specifies that a parameter is deprecated and SHOULD
|
|
3434
|
+
* be transitioned out of usage.
|
|
3435
|
+
*/
|
|
3228
3436
|
deprecated?: boolean | null;
|
|
3229
3437
|
example?: unknown;
|
|
3230
3438
|
examples?: {
|
|
3231
3439
|
[key: string]: components["schemas"]["ReferenceOr3"];
|
|
3232
3440
|
};
|
|
3233
3441
|
explode?: boolean | null;
|
|
3234
|
-
/**
|
|
3442
|
+
/**
|
|
3443
|
+
* @description Describes how the parameter value will be serialized depending on
|
|
3235
3444
|
* the type of the parameter value. Default values (based on value of
|
|
3236
3445
|
* in): for query - form; for path - simple; for header - simple; for
|
|
3237
|
-
* cookie - form.
|
|
3446
|
+
* cookie - form.
|
|
3447
|
+
*/
|
|
3238
3448
|
style?: components["schemas"]["HeaderStyle"];
|
|
3239
3449
|
/** @constant */
|
|
3240
3450
|
in: "header";
|
|
@@ -3249,7 +3459,8 @@ export interface components {
|
|
|
3249
3459
|
[key: string]: components["schemas"]["MediaType"];
|
|
3250
3460
|
};
|
|
3251
3461
|
})) | (({
|
|
3252
|
-
/**
|
|
3462
|
+
/**
|
|
3463
|
+
* @description REQUIRED. The name of the parameter. Parameter names are case sensitive.
|
|
3253
3464
|
* If in is "path", the name field MUST correspond to the associated path
|
|
3254
3465
|
* segment from the path field in the Paths Object. See Path Templating for
|
|
3255
3466
|
* further information.
|
|
@@ -3258,30 +3469,39 @@ export interface components {
|
|
|
3258
3469
|
* "Authorization", the parameter definition SHALL be ignored.
|
|
3259
3470
|
*
|
|
3260
3471
|
* For all other cases, the name corresponds to the parameter name
|
|
3261
|
-
* used by the in property.
|
|
3472
|
+
* used by the in property.
|
|
3473
|
+
*/
|
|
3262
3474
|
name: string;
|
|
3263
|
-
/**
|
|
3475
|
+
/**
|
|
3476
|
+
* @description A brief description of the parameter. This could
|
|
3264
3477
|
* contain examples of use. CommonMark syntax MAY be
|
|
3265
|
-
* used for rich text representation.
|
|
3478
|
+
* used for rich text representation.
|
|
3479
|
+
*/
|
|
3266
3480
|
description?: string | null;
|
|
3267
|
-
/**
|
|
3481
|
+
/**
|
|
3482
|
+
* @description Determines whether this parameter is mandatory.
|
|
3268
3483
|
* If the parameter location is "path", this property
|
|
3269
3484
|
* is REQUIRED and its value MUST be true. Otherwise,
|
|
3270
3485
|
* the property MAY be included and its default value
|
|
3271
|
-
* is false.
|
|
3486
|
+
* is false.
|
|
3487
|
+
*/
|
|
3272
3488
|
required?: boolean;
|
|
3273
|
-
/**
|
|
3274
|
-
*
|
|
3489
|
+
/**
|
|
3490
|
+
* @description Specifies that a parameter is deprecated and SHOULD
|
|
3491
|
+
* be transitioned out of usage.
|
|
3492
|
+
*/
|
|
3275
3493
|
deprecated?: boolean | null;
|
|
3276
3494
|
example?: unknown;
|
|
3277
3495
|
examples?: {
|
|
3278
3496
|
[key: string]: components["schemas"]["ReferenceOr3"];
|
|
3279
3497
|
};
|
|
3280
3498
|
explode?: boolean | null;
|
|
3281
|
-
/**
|
|
3499
|
+
/**
|
|
3500
|
+
* @description Describes how the parameter value will be serialized depending on
|
|
3282
3501
|
* the type of the parameter value. Default values (based on value of
|
|
3283
3502
|
* in): for query - form; for path - simple; for header - simple; for
|
|
3284
|
-
* cookie - form.
|
|
3503
|
+
* cookie - form.
|
|
3504
|
+
*/
|
|
3285
3505
|
style?: components["schemas"]["PathStyle"];
|
|
3286
3506
|
/** @constant */
|
|
3287
3507
|
in: "path";
|
|
@@ -3296,7 +3516,8 @@ export interface components {
|
|
|
3296
3516
|
[key: string]: components["schemas"]["MediaType"];
|
|
3297
3517
|
};
|
|
3298
3518
|
})) | (({
|
|
3299
|
-
/**
|
|
3519
|
+
/**
|
|
3520
|
+
* @description REQUIRED. The name of the parameter. Parameter names are case sensitive.
|
|
3300
3521
|
* If in is "path", the name field MUST correspond to the associated path
|
|
3301
3522
|
* segment from the path field in the Paths Object. See Path Templating for
|
|
3302
3523
|
* further information.
|
|
@@ -3305,30 +3526,39 @@ export interface components {
|
|
|
3305
3526
|
* "Authorization", the parameter definition SHALL be ignored.
|
|
3306
3527
|
*
|
|
3307
3528
|
* For all other cases, the name corresponds to the parameter name
|
|
3308
|
-
* used by the in property.
|
|
3529
|
+
* used by the in property.
|
|
3530
|
+
*/
|
|
3309
3531
|
name: string;
|
|
3310
|
-
/**
|
|
3532
|
+
/**
|
|
3533
|
+
* @description A brief description of the parameter. This could
|
|
3311
3534
|
* contain examples of use. CommonMark syntax MAY be
|
|
3312
|
-
* used for rich text representation.
|
|
3535
|
+
* used for rich text representation.
|
|
3536
|
+
*/
|
|
3313
3537
|
description?: string | null;
|
|
3314
|
-
/**
|
|
3538
|
+
/**
|
|
3539
|
+
* @description Determines whether this parameter is mandatory.
|
|
3315
3540
|
* If the parameter location is "path", this property
|
|
3316
3541
|
* is REQUIRED and its value MUST be true. Otherwise,
|
|
3317
3542
|
* the property MAY be included and its default value
|
|
3318
|
-
* is false.
|
|
3543
|
+
* is false.
|
|
3544
|
+
*/
|
|
3319
3545
|
required?: boolean;
|
|
3320
|
-
/**
|
|
3321
|
-
*
|
|
3546
|
+
/**
|
|
3547
|
+
* @description Specifies that a parameter is deprecated and SHOULD
|
|
3548
|
+
* be transitioned out of usage.
|
|
3549
|
+
*/
|
|
3322
3550
|
deprecated?: boolean | null;
|
|
3323
3551
|
example?: unknown;
|
|
3324
3552
|
examples?: {
|
|
3325
3553
|
[key: string]: components["schemas"]["ReferenceOr3"];
|
|
3326
3554
|
};
|
|
3327
3555
|
explode?: boolean | null;
|
|
3328
|
-
/**
|
|
3556
|
+
/**
|
|
3557
|
+
* @description Describes how the parameter value will be serialized depending on
|
|
3329
3558
|
* the type of the parameter value. Default values (based on value of
|
|
3330
3559
|
* in): for query - form; for path - simple; for header - simple; for
|
|
3331
|
-
* cookie - form.
|
|
3560
|
+
* cookie - form.
|
|
3561
|
+
*/
|
|
3332
3562
|
style?: components["schemas"]["CookieStyle"];
|
|
3333
3563
|
/** @constant */
|
|
3334
3564
|
in: "cookie";
|
|
@@ -3346,13 +3576,15 @@ export interface components {
|
|
|
3346
3576
|
SchemaObject: {
|
|
3347
3577
|
/** @description Additional external documentation for this schema. */
|
|
3348
3578
|
externalDocs?: components["schemas"]["ExternalDocumentation"] | null;
|
|
3349
|
-
/**
|
|
3579
|
+
/**
|
|
3580
|
+
* @description A free-form property to include an example of an instance for this
|
|
3350
3581
|
* schema. To represent examples that cannot be naturally represented in
|
|
3351
3582
|
* JSON or YAML, a string value can be used to contain the example with
|
|
3352
3583
|
* escaping where necessary. **Deprecated:** The `example` property has
|
|
3353
3584
|
* been deprecated in favor of the JSON Schema `examples` keyword. Use
|
|
3354
3585
|
* of `example` is discouraged, and later versions of this
|
|
3355
|
-
* specification may remove it.
|
|
3586
|
+
* specification may remove it.
|
|
3587
|
+
*/
|
|
3356
3588
|
example?: unknown;
|
|
3357
3589
|
};
|
|
3358
3590
|
MediaType: {
|
|
@@ -3368,66 +3600,85 @@ export interface components {
|
|
|
3368
3600
|
[key: string]: unknown;
|
|
3369
3601
|
};
|
|
3370
3602
|
ReferenceOr3: {
|
|
3371
|
-
/**
|
|
3372
|
-
*
|
|
3603
|
+
/**
|
|
3604
|
+
* @description REQUIRED. The reference identifier. This MUST be in the form of a
|
|
3605
|
+
* URI.
|
|
3606
|
+
*/
|
|
3373
3607
|
$ref: string;
|
|
3374
|
-
/**
|
|
3608
|
+
/**
|
|
3609
|
+
* @description A short summary which by default SHOULD override that of the
|
|
3375
3610
|
* referenced component. If the referenced object-type does not allow a
|
|
3376
|
-
* `summary` field, then this field has no effect.
|
|
3611
|
+
* `summary` field, then this field has no effect.
|
|
3612
|
+
*/
|
|
3377
3613
|
summary?: string | null;
|
|
3378
|
-
/**
|
|
3614
|
+
/**
|
|
3615
|
+
* @description A description which by default SHOULD override that of the
|
|
3379
3616
|
* referenced component. CommonMark syntax MAY be used for rich text
|
|
3380
3617
|
* representation. If the referenced object-type does not allow a
|
|
3381
|
-
* `description` field, then this field has no effect.
|
|
3618
|
+
* `description` field, then this field has no effect.
|
|
3619
|
+
*/
|
|
3382
3620
|
description?: string | null;
|
|
3383
3621
|
} | components["schemas"]["Example"];
|
|
3384
3622
|
Example: {
|
|
3385
3623
|
/** @description Short description for the example. */
|
|
3386
3624
|
summary?: string | null;
|
|
3387
|
-
/**
|
|
3388
|
-
*
|
|
3625
|
+
/**
|
|
3626
|
+
* @description Long description for the example.
|
|
3627
|
+
* CommonMark syntax MAY be used for rich text representation.
|
|
3628
|
+
*/
|
|
3389
3629
|
description?: string | null;
|
|
3390
|
-
/**
|
|
3630
|
+
/**
|
|
3631
|
+
* @description Embedded literal example. The `value` field and `externalValue`
|
|
3391
3632
|
* field are mutually exclusive. To represent examples of
|
|
3392
3633
|
* media types that cannot naturally represented in JSON or YAML,
|
|
3393
|
-
* use a string value to contain the example, escaping where necessary.
|
|
3634
|
+
* use a string value to contain the example, escaping where necessary.
|
|
3635
|
+
*/
|
|
3394
3636
|
value?: unknown;
|
|
3395
|
-
/**
|
|
3637
|
+
/**
|
|
3638
|
+
* @description A URI that points to the literal example.
|
|
3396
3639
|
* This provides the capability to reference examples that cannot
|
|
3397
3640
|
* easily be included in JSON or YAML documents. The `value` field and
|
|
3398
3641
|
* `externalValue` field are mutually exclusive. See the rules for
|
|
3399
|
-
* resolving Relative References.
|
|
3642
|
+
* resolving Relative References.
|
|
3643
|
+
*/
|
|
3400
3644
|
externalValue?: string | null;
|
|
3401
3645
|
} & {
|
|
3402
3646
|
[key: string]: unknown;
|
|
3403
3647
|
};
|
|
3404
3648
|
/** @description A single encoding definition applied to a single schema property. */
|
|
3405
3649
|
Encoding: {
|
|
3406
|
-
/**
|
|
3650
|
+
/**
|
|
3651
|
+
* @description The Content-Type for encoding a specific property.
|
|
3407
3652
|
* Default value depends on the property type:
|
|
3408
3653
|
* for object - application/json;
|
|
3409
3654
|
* for array – the default is defined based on the inner type.
|
|
3410
3655
|
* for all other cases the default is `application/octet-stream`.
|
|
3411
3656
|
* The value can be a specific media type (e.g. application/json),
|
|
3412
3657
|
* a wildcard media type (e.g. image/*), or a comma-separated list of the
|
|
3413
|
-
* two types.
|
|
3658
|
+
* two types.
|
|
3659
|
+
*/
|
|
3414
3660
|
contentType?: string | null;
|
|
3415
|
-
/**
|
|
3661
|
+
/**
|
|
3662
|
+
* @description A map allowing additional information to be provided as headers,
|
|
3416
3663
|
* for example Content-Disposition. Content-Type is described separately
|
|
3417
3664
|
* and SHALL be ignored in this section. This property SHALL be ignored
|
|
3418
|
-
* if the request body media type is not a multipart.
|
|
3665
|
+
* if the request body media type is not a multipart.
|
|
3666
|
+
*/
|
|
3419
3667
|
headers?: {
|
|
3420
3668
|
[key: string]: components["schemas"]["ReferenceOr4"];
|
|
3421
3669
|
};
|
|
3422
|
-
/**
|
|
3670
|
+
/**
|
|
3671
|
+
* @description Describes how a specific property value will be serialized depending
|
|
3423
3672
|
* on its type. See Parameter Object for details on the style property.
|
|
3424
3673
|
* The behavior follows the same values as query parameters, including
|
|
3425
3674
|
* default values. This property SHALL be ignored if the request body
|
|
3426
3675
|
* media type is not application/x-www-form-urlencoded or
|
|
3427
3676
|
* multipart/form-data. If a value is explicitly defined, then the value of
|
|
3428
|
-
* `contentType` (implicit or explicit) SHALL be ignored.
|
|
3677
|
+
* `contentType` (implicit or explicit) SHALL be ignored.
|
|
3678
|
+
*/
|
|
3429
3679
|
style?: components["schemas"]["QueryStyle"] | null;
|
|
3430
|
-
/**
|
|
3680
|
+
/**
|
|
3681
|
+
* @description When this is true, property values of type array or object generate
|
|
3431
3682
|
* separate parameters for each value of the array, or key-value-pair
|
|
3432
3683
|
* of the map. For other types of properties this property has no effect.
|
|
3433
3684
|
* When style is form, the default value is true.
|
|
@@ -3438,55 +3689,72 @@ export interface components {
|
|
|
3438
3689
|
* explicit) SHALL be ignored.
|
|
3439
3690
|
*
|
|
3440
3691
|
* In this Library this value defaults to false always despite the
|
|
3441
|
-
* specification.
|
|
3692
|
+
* specification.
|
|
3693
|
+
*/
|
|
3442
3694
|
explode?: boolean;
|
|
3443
|
-
/**
|
|
3695
|
+
/**
|
|
3696
|
+
* @description Determines whether the parameter value SHOULD allow reserved characters,
|
|
3444
3697
|
* as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without
|
|
3445
3698
|
* percent-encoding. The default value is false. This property SHALL be
|
|
3446
3699
|
* ignored if the request body media type is not
|
|
3447
3700
|
* application/x-www-form-urlencoded or multipart/form-data. If a value is
|
|
3448
3701
|
* explicitly defined, then the value of `contentType` (implicit or
|
|
3449
|
-
* explicit) SHALL be ignored.
|
|
3702
|
+
* explicit) SHALL be ignored.
|
|
3703
|
+
*/
|
|
3450
3704
|
allowReserved?: boolean;
|
|
3451
3705
|
} & {
|
|
3452
3706
|
[key: string]: unknown;
|
|
3453
3707
|
};
|
|
3454
3708
|
ReferenceOr4: {
|
|
3455
|
-
/**
|
|
3456
|
-
*
|
|
3709
|
+
/**
|
|
3710
|
+
* @description REQUIRED. The reference identifier. This MUST be in the form of a
|
|
3711
|
+
* URI.
|
|
3712
|
+
*/
|
|
3457
3713
|
$ref: string;
|
|
3458
|
-
/**
|
|
3714
|
+
/**
|
|
3715
|
+
* @description A short summary which by default SHOULD override that of the
|
|
3459
3716
|
* referenced component. If the referenced object-type does not allow a
|
|
3460
|
-
* `summary` field, then this field has no effect.
|
|
3717
|
+
* `summary` field, then this field has no effect.
|
|
3718
|
+
*/
|
|
3461
3719
|
summary?: string | null;
|
|
3462
|
-
/**
|
|
3720
|
+
/**
|
|
3721
|
+
* @description A description which by default SHOULD override that of the
|
|
3463
3722
|
* referenced component. CommonMark syntax MAY be used for rich text
|
|
3464
3723
|
* representation. If the referenced object-type does not allow a
|
|
3465
|
-
* `description` field, then this field has no effect.
|
|
3724
|
+
* `description` field, then this field has no effect.
|
|
3725
|
+
*/
|
|
3466
3726
|
description?: string | null;
|
|
3467
3727
|
} | components["schemas"]["Header"];
|
|
3468
|
-
/**
|
|
3728
|
+
/**
|
|
3729
|
+
* @description The Header Object follows the structure of the Parameter Object with the
|
|
3469
3730
|
* following changes:
|
|
3470
3731
|
*
|
|
3471
3732
|
* 1) name MUST NOT be specified, it is given in the corresponding headers map.
|
|
3472
3733
|
* 2) in MUST NOT be specified, it is implicitly in header.
|
|
3473
3734
|
* 3) All traits that are affected by the location MUST be applicable to a
|
|
3474
|
-
* location of header (for example, style).
|
|
3735
|
+
* location of header (for example, style).
|
|
3736
|
+
*/
|
|
3475
3737
|
Header: ({
|
|
3476
|
-
/**
|
|
3738
|
+
/**
|
|
3739
|
+
* @description A brief description of the parameter. This could
|
|
3477
3740
|
* contain examples of use. CommonMark syntax MAY be
|
|
3478
|
-
* used for rich text representation.
|
|
3741
|
+
* used for rich text representation.
|
|
3742
|
+
*/
|
|
3479
3743
|
description?: string | null;
|
|
3480
3744
|
/** @default simple */
|
|
3481
3745
|
style: components["schemas"]["HeaderStyle"];
|
|
3482
|
-
/**
|
|
3746
|
+
/**
|
|
3747
|
+
* @description Determines whether this parameter is mandatory.
|
|
3483
3748
|
* If the parameter location is "path", this property
|
|
3484
3749
|
* is REQUIRED and its value MUST be true. Otherwise,
|
|
3485
3750
|
* the property MAY be included and its default value
|
|
3486
|
-
* is false.
|
|
3751
|
+
* is false.
|
|
3752
|
+
*/
|
|
3487
3753
|
required?: boolean;
|
|
3488
|
-
/**
|
|
3489
|
-
*
|
|
3754
|
+
/**
|
|
3755
|
+
* @description Specifies that a parameter is deprecated and SHOULD
|
|
3756
|
+
* be transitioned out of usage.
|
|
3757
|
+
*/
|
|
3490
3758
|
deprecated?: boolean | null;
|
|
3491
3759
|
example?: unknown;
|
|
3492
3760
|
examples?: {
|
|
@@ -3512,82 +3780,110 @@ export interface components {
|
|
|
3512
3780
|
/** @enum {string} */
|
|
3513
3781
|
CookieStyle: "form";
|
|
3514
3782
|
ReferenceOr5: {
|
|
3515
|
-
/**
|
|
3516
|
-
*
|
|
3783
|
+
/**
|
|
3784
|
+
* @description REQUIRED. The reference identifier. This MUST be in the form of a
|
|
3785
|
+
* URI.
|
|
3786
|
+
*/
|
|
3517
3787
|
$ref: string;
|
|
3518
|
-
/**
|
|
3788
|
+
/**
|
|
3789
|
+
* @description A short summary which by default SHOULD override that of the
|
|
3519
3790
|
* referenced component. If the referenced object-type does not allow a
|
|
3520
|
-
* `summary` field, then this field has no effect.
|
|
3791
|
+
* `summary` field, then this field has no effect.
|
|
3792
|
+
*/
|
|
3521
3793
|
summary?: string | null;
|
|
3522
|
-
/**
|
|
3794
|
+
/**
|
|
3795
|
+
* @description A description which by default SHOULD override that of the
|
|
3523
3796
|
* referenced component. CommonMark syntax MAY be used for rich text
|
|
3524
3797
|
* representation. If the referenced object-type does not allow a
|
|
3525
|
-
* `description` field, then this field has no effect.
|
|
3798
|
+
* `description` field, then this field has no effect.
|
|
3799
|
+
*/
|
|
3526
3800
|
description?: string | null;
|
|
3527
3801
|
} | components["schemas"]["RequestBody"];
|
|
3528
3802
|
RequestBody: {
|
|
3529
|
-
/**
|
|
3803
|
+
/**
|
|
3804
|
+
* @description A brief description of the request body.
|
|
3530
3805
|
* This could contain examples of use.
|
|
3531
|
-
* CommonMark syntax MAY be used for rich text representation.
|
|
3806
|
+
* CommonMark syntax MAY be used for rich text representation.
|
|
3807
|
+
*/
|
|
3532
3808
|
description?: string | null;
|
|
3533
|
-
/**
|
|
3809
|
+
/**
|
|
3810
|
+
* @description REQUIRED. The content of the request body.
|
|
3534
3811
|
* The key is a media type or media type range and
|
|
3535
3812
|
* the value describes it. For requests that match
|
|
3536
3813
|
* multiple keys, only the most specific key is applicable.
|
|
3537
|
-
* e.g. text/plain overrides text/*
|
|
3814
|
+
* e.g. text/plain overrides text/*
|
|
3815
|
+
*/
|
|
3538
3816
|
content?: {
|
|
3539
3817
|
[key: string]: components["schemas"]["MediaType"];
|
|
3540
3818
|
};
|
|
3541
|
-
/**
|
|
3542
|
-
*
|
|
3819
|
+
/**
|
|
3820
|
+
* @description Determines if the request body is required in the
|
|
3821
|
+
* request. Defaults to false.
|
|
3822
|
+
*/
|
|
3543
3823
|
required?: boolean;
|
|
3544
3824
|
} & {
|
|
3545
3825
|
[key: string]: unknown;
|
|
3546
3826
|
};
|
|
3547
3827
|
Responses: {
|
|
3548
|
-
/**
|
|
3828
|
+
/**
|
|
3829
|
+
* @description The documentation of responses other than the ones declared
|
|
3549
3830
|
* for specific HTTP response codes. Use this field to cover
|
|
3550
|
-
* undeclared responses.
|
|
3831
|
+
* undeclared responses.
|
|
3832
|
+
*/
|
|
3551
3833
|
default?: components["schemas"]["ReferenceOr6"] | null;
|
|
3552
3834
|
} & {
|
|
3553
3835
|
[key: string]: components["schemas"]["ReferenceOr6"];
|
|
3554
3836
|
};
|
|
3555
3837
|
ReferenceOr6: {
|
|
3556
|
-
/**
|
|
3557
|
-
*
|
|
3838
|
+
/**
|
|
3839
|
+
* @description REQUIRED. The reference identifier. This MUST be in the form of a
|
|
3840
|
+
* URI.
|
|
3841
|
+
*/
|
|
3558
3842
|
$ref: string;
|
|
3559
|
-
/**
|
|
3843
|
+
/**
|
|
3844
|
+
* @description A short summary which by default SHOULD override that of the
|
|
3560
3845
|
* referenced component. If the referenced object-type does not allow a
|
|
3561
|
-
* `summary` field, then this field has no effect.
|
|
3846
|
+
* `summary` field, then this field has no effect.
|
|
3847
|
+
*/
|
|
3562
3848
|
summary?: string | null;
|
|
3563
|
-
/**
|
|
3849
|
+
/**
|
|
3850
|
+
* @description A description which by default SHOULD override that of the
|
|
3564
3851
|
* referenced component. CommonMark syntax MAY be used for rich text
|
|
3565
3852
|
* representation. If the referenced object-type does not allow a
|
|
3566
|
-
* `description` field, then this field has no effect.
|
|
3853
|
+
* `description` field, then this field has no effect.
|
|
3854
|
+
*/
|
|
3567
3855
|
description?: string | null;
|
|
3568
3856
|
} | components["schemas"]["Response"];
|
|
3569
3857
|
Response: {
|
|
3570
|
-
/**
|
|
3571
|
-
*
|
|
3858
|
+
/**
|
|
3859
|
+
* @description REQUIRED. A description of the response.
|
|
3860
|
+
* CommonMark syntax MAY be used for rich text representation.
|
|
3861
|
+
*/
|
|
3572
3862
|
description: string;
|
|
3573
|
-
/**
|
|
3863
|
+
/**
|
|
3864
|
+
* @description Maps a header name to its definition.
|
|
3574
3865
|
* RFC7230 states header names are case insensitive.
|
|
3575
3866
|
* If a response header is defined with the name "Content-Type",
|
|
3576
|
-
* it SHALL be ignored.
|
|
3867
|
+
* it SHALL be ignored.
|
|
3868
|
+
*/
|
|
3577
3869
|
headers?: {
|
|
3578
3870
|
[key: string]: components["schemas"]["ReferenceOr4"];
|
|
3579
3871
|
};
|
|
3580
|
-
/**
|
|
3872
|
+
/**
|
|
3873
|
+
* @description A map containing descriptions of potential response payloads.
|
|
3581
3874
|
* The key is a media type or media type range and the value
|
|
3582
3875
|
* describes it. For responses that match multiple keys,
|
|
3583
3876
|
* only the most specific key is applicable. e.g. text/plain
|
|
3584
|
-
* overrides text/*
|
|
3877
|
+
* overrides text/*
|
|
3878
|
+
*/
|
|
3585
3879
|
content?: {
|
|
3586
3880
|
[key: string]: components["schemas"]["MediaType"];
|
|
3587
3881
|
};
|
|
3588
|
-
/**
|
|
3882
|
+
/**
|
|
3883
|
+
* @description A map of operations links that can be followed from the response.
|
|
3589
3884
|
* The key of the map is a short name for the link, following
|
|
3590
|
-
* the naming constraints of the names for Component Objects.
|
|
3885
|
+
* the naming constraints of the names for Component Objects.
|
|
3886
|
+
*/
|
|
3591
3887
|
links?: {
|
|
3592
3888
|
[key: string]: components["schemas"]["ReferenceOr7"];
|
|
3593
3889
|
};
|
|
@@ -3595,20 +3891,27 @@ export interface components {
|
|
|
3595
3891
|
[key: string]: unknown;
|
|
3596
3892
|
};
|
|
3597
3893
|
ReferenceOr7: {
|
|
3598
|
-
/**
|
|
3599
|
-
*
|
|
3894
|
+
/**
|
|
3895
|
+
* @description REQUIRED. The reference identifier. This MUST be in the form of a
|
|
3896
|
+
* URI.
|
|
3897
|
+
*/
|
|
3600
3898
|
$ref: string;
|
|
3601
|
-
/**
|
|
3899
|
+
/**
|
|
3900
|
+
* @description A short summary which by default SHOULD override that of the
|
|
3602
3901
|
* referenced component. If the referenced object-type does not allow a
|
|
3603
|
-
* `summary` field, then this field has no effect.
|
|
3902
|
+
* `summary` field, then this field has no effect.
|
|
3903
|
+
*/
|
|
3604
3904
|
summary?: string | null;
|
|
3605
|
-
/**
|
|
3905
|
+
/**
|
|
3906
|
+
* @description A description which by default SHOULD override that of the
|
|
3606
3907
|
* referenced component. CommonMark syntax MAY be used for rich text
|
|
3607
3908
|
* representation. If the referenced object-type does not allow a
|
|
3608
|
-
* `description` field, then this field has no effect.
|
|
3909
|
+
* `description` field, then this field has no effect.
|
|
3910
|
+
*/
|
|
3609
3911
|
description?: string | null;
|
|
3610
3912
|
} | components["schemas"]["Link"];
|
|
3611
|
-
/**
|
|
3913
|
+
/**
|
|
3914
|
+
* @description The Link object represents a possible design-time link for a response.
|
|
3612
3915
|
* The presence of a link does not guarantee the caller's ability to
|
|
3613
3916
|
* successfully invoke it, rather it provides a known relationship and
|
|
3614
3917
|
* traversal mechanism between responses and other operations.
|
|
@@ -3619,21 +3922,28 @@ export interface components {
|
|
|
3619
3922
|
*
|
|
3620
3923
|
* For computing links, and providing instructions to execute them,
|
|
3621
3924
|
* a runtime expression is used for accessing values in an operation
|
|
3622
|
-
* and using them as parameters while invoking the linked operation.
|
|
3925
|
+
* and using them as parameters while invoking the linked operation.
|
|
3926
|
+
*/
|
|
3623
3927
|
Link: ({
|
|
3624
|
-
/**
|
|
3625
|
-
*
|
|
3928
|
+
/**
|
|
3929
|
+
* @description A description of the link.
|
|
3930
|
+
* CommonMark syntax MAY be used for rich text representation.
|
|
3931
|
+
*/
|
|
3626
3932
|
description?: string | null;
|
|
3627
|
-
/**
|
|
3628
|
-
*
|
|
3933
|
+
/**
|
|
3934
|
+
* @description A literal value or {expression} to use as a request body
|
|
3935
|
+
* when calling the target operation.
|
|
3936
|
+
*/
|
|
3629
3937
|
requestBody?: unknown;
|
|
3630
|
-
/**
|
|
3938
|
+
/**
|
|
3939
|
+
* @description A map representing parameters to pass to an operation
|
|
3631
3940
|
* as specified with operationId or identified via operationRef.
|
|
3632
3941
|
* The key is the parameter name to be used, whereas the value
|
|
3633
3942
|
* can be a constant or an expression to be evaluated and passed
|
|
3634
3943
|
* to the linked operation. The parameter name can be qualified
|
|
3635
3944
|
* using the parameter location [{in}.]{name} for operations
|
|
3636
|
-
* that use the same parameter name in different locations (e.g. path.id).
|
|
3945
|
+
* that use the same parameter name in different locations (e.g. path.id).
|
|
3946
|
+
*/
|
|
3637
3947
|
parameters?: {
|
|
3638
3948
|
[key: string]: unknown;
|
|
3639
3949
|
};
|
|
@@ -3649,25 +3959,33 @@ export interface components {
|
|
|
3649
3959
|
operationId: string;
|
|
3650
3960
|
});
|
|
3651
3961
|
ReferenceOr8: {
|
|
3652
|
-
/**
|
|
3653
|
-
*
|
|
3962
|
+
/**
|
|
3963
|
+
* @description REQUIRED. The reference identifier. This MUST be in the form of a
|
|
3964
|
+
* URI.
|
|
3965
|
+
*/
|
|
3654
3966
|
$ref: string;
|
|
3655
|
-
/**
|
|
3967
|
+
/**
|
|
3968
|
+
* @description A short summary which by default SHOULD override that of the
|
|
3656
3969
|
* referenced component. If the referenced object-type does not allow a
|
|
3657
|
-
* `summary` field, then this field has no effect.
|
|
3970
|
+
* `summary` field, then this field has no effect.
|
|
3971
|
+
*/
|
|
3658
3972
|
summary?: string | null;
|
|
3659
|
-
/**
|
|
3973
|
+
/**
|
|
3974
|
+
* @description A description which by default SHOULD override that of the
|
|
3660
3975
|
* referenced component. CommonMark syntax MAY be used for rich text
|
|
3661
3976
|
* representation. If the referenced object-type does not allow a
|
|
3662
|
-
* `description` field, then this field has no effect.
|
|
3977
|
+
* `description` field, then this field has no effect.
|
|
3978
|
+
*/
|
|
3663
3979
|
description?: string | null;
|
|
3664
3980
|
} | {
|
|
3665
3981
|
[key: string]: components["schemas"]["ReferenceOr"];
|
|
3666
3982
|
};
|
|
3667
|
-
/**
|
|
3983
|
+
/**
|
|
3984
|
+
* @description Holds a set of reusable objects for different aspects of the OAS.
|
|
3668
3985
|
* All objects defined within the components object will have no effect
|
|
3669
3986
|
* on the API unless they are explicitly referenced from properties
|
|
3670
|
-
* outside the components object.
|
|
3987
|
+
* outside the components object.
|
|
3988
|
+
*/
|
|
3671
3989
|
Components: {
|
|
3672
3990
|
/** @description An object to hold reusable Security Scheme Objects. */
|
|
3673
3991
|
securitySchemes?: {
|
|
@@ -3713,24 +4031,32 @@ export interface components {
|
|
|
3713
4031
|
[key: string]: unknown;
|
|
3714
4032
|
};
|
|
3715
4033
|
ReferenceOr9: {
|
|
3716
|
-
/**
|
|
3717
|
-
*
|
|
4034
|
+
/**
|
|
4035
|
+
* @description REQUIRED. The reference identifier. This MUST be in the form of a
|
|
4036
|
+
* URI.
|
|
4037
|
+
*/
|
|
3718
4038
|
$ref: string;
|
|
3719
|
-
/**
|
|
4039
|
+
/**
|
|
4040
|
+
* @description A short summary which by default SHOULD override that of the
|
|
3720
4041
|
* referenced component. If the referenced object-type does not allow a
|
|
3721
|
-
* `summary` field, then this field has no effect.
|
|
4042
|
+
* `summary` field, then this field has no effect.
|
|
4043
|
+
*/
|
|
3722
4044
|
summary?: string | null;
|
|
3723
|
-
/**
|
|
4045
|
+
/**
|
|
4046
|
+
* @description A description which by default SHOULD override that of the
|
|
3724
4047
|
* referenced component. CommonMark syntax MAY be used for rich text
|
|
3725
4048
|
* representation. If the referenced object-type does not allow a
|
|
3726
|
-
* `description` field, then this field has no effect.
|
|
4049
|
+
* `description` field, then this field has no effect.
|
|
4050
|
+
*/
|
|
3727
4051
|
description?: string | null;
|
|
3728
4052
|
} | components["schemas"]["SecurityScheme"];
|
|
3729
|
-
/**
|
|
4053
|
+
/**
|
|
4054
|
+
* @description Defines a security scheme that can be used by the operations.
|
|
3730
4055
|
* Supported schemes are HTTP authentication, an API key (either as a
|
|
3731
4056
|
* header or as a query parameter), OAuth2's common flows (implicit, password,
|
|
3732
4057
|
* application and access code) as defined in RFC6749, and OpenID Connect
|
|
3733
|
-
* Discovery.
|
|
4058
|
+
* Discovery.
|
|
4059
|
+
*/
|
|
3734
4060
|
SecurityScheme: ({
|
|
3735
4061
|
in: components["schemas"]["ApiKeyLocation"];
|
|
3736
4062
|
name: string;
|
|
@@ -3919,14 +4245,18 @@ export interface components {
|
|
|
3919
4245
|
};
|
|
3920
4246
|
};
|
|
3921
4247
|
}) | unknown);
|
|
3922
|
-
/**
|
|
4248
|
+
/**
|
|
4249
|
+
* @description Adds metadata to a single tag that is used by the
|
|
3923
4250
|
* Operation Object. It is not mandatory to have a
|
|
3924
|
-
* Tag Object per tag defined in the Operation Object instances.
|
|
4251
|
+
* Tag Object per tag defined in the Operation Object instances.
|
|
4252
|
+
*/
|
|
3925
4253
|
Tag: {
|
|
3926
4254
|
/** @description REQUIRED. The name of the tag. */
|
|
3927
4255
|
name: string;
|
|
3928
|
-
/**
|
|
3929
|
-
*
|
|
4256
|
+
/**
|
|
4257
|
+
* @description A description for the tag.
|
|
4258
|
+
* CommonMark syntax MAY be used for rich text representation.
|
|
4259
|
+
*/
|
|
3930
4260
|
description?: string | null;
|
|
3931
4261
|
/** @description Additional external documentation for this tag. */
|
|
3932
4262
|
externalDocs?: components["schemas"]["ExternalDocumentation"] | null;
|
|
@@ -4024,17 +4354,21 @@ export interface components {
|
|
|
4024
4354
|
MarketLiveInfo: {
|
|
4025
4355
|
/** Format: uint32 */
|
|
4026
4356
|
marketId: number;
|
|
4027
|
-
/**
|
|
4357
|
+
/**
|
|
4358
|
+
* @description Admin can freeze market.
|
|
4028
4359
|
* Can happen when there are issues with market setup and need to stop operations.
|
|
4029
|
-
* Or if market permanently delisted (orderbook l2 is zero and perpetuals open interest would be zero in this case).
|
|
4360
|
+
* Or if market permanently delisted (orderbook l2 is zero and perpetuals open interest would be zero in this case).
|
|
4361
|
+
*/
|
|
4030
4362
|
frozen?: boolean;
|
|
4031
4363
|
/** Format: double */
|
|
4032
4364
|
indexPrice?: number | null;
|
|
4033
4365
|
/** Format: double */
|
|
4034
4366
|
indexPriceConf?: number | null;
|
|
4035
4367
|
perpetuals?: components["schemas"]["MarketLivePerpInfo"] | null;
|
|
4036
|
-
/**
|
|
4037
|
-
*
|
|
4368
|
+
/**
|
|
4369
|
+
* @description Historical data loaded from the internal database. This may be null if an internal error prevents
|
|
4370
|
+
* the data from being loaded. Clients must handle null gracefully.
|
|
4371
|
+
*/
|
|
4038
4372
|
historical?: components["schemas"]["MarketLiveHistoricalInfo"] | null;
|
|
4039
4373
|
};
|
|
4040
4374
|
MarketLivePerpInfo: {
|
|
@@ -4050,8 +4384,10 @@ export interface components {
|
|
|
4050
4384
|
* funding rate.
|
|
4051
4385
|
*/
|
|
4052
4386
|
projectedFundingRate?: number | null;
|
|
4053
|
-
/**
|
|
4054
|
-
*
|
|
4387
|
+
/**
|
|
4388
|
+
* @description The next time at which funding will be paid. Locked to the hour, though
|
|
4389
|
+
* may be delayed if oracle updates are delayed.
|
|
4390
|
+
*/
|
|
4055
4391
|
nextFundingTime: string;
|
|
4056
4392
|
/**
|
|
4057
4393
|
* Format: double
|
|
@@ -4142,16 +4478,12 @@ export interface components {
|
|
|
4142
4478
|
message: string;
|
|
4143
4479
|
};
|
|
4144
4480
|
ActionNotFound: null;
|
|
4481
|
+
Timestamp: string;
|
|
4145
4482
|
/**
|
|
4146
|
-
*
|
|
4147
|
-
* @description Non negative time in seconds (oracle precision).
|
|
4148
|
-
* In production within engine determinsitic code,
|
|
4149
|
-
* this time can only go forward and cannot be `Default`.
|
|
4150
|
-
*/
|
|
4151
|
-
Timestamp: number;
|
|
4152
|
-
/** @description Returns fee parts per market per balance change per action per account.
|
|
4483
|
+
* @description Returns fee parts per market per balance change per action per account.
|
|
4153
4484
|
* Fee is taken from user without return.
|
|
4154
|
-
* Please note that some operations need some deposit which will be returned - these are not part of fees.
|
|
4485
|
+
* Please note that some operations need some deposit which will be returned - these are not part of fees.
|
|
4486
|
+
*/
|
|
4155
4487
|
FillRole: "maker" | "taker";
|
|
4156
4488
|
/**
|
|
4157
4489
|
* Format: uint32
|
|
@@ -4231,12 +4563,16 @@ export interface components {
|
|
|
4231
4563
|
confidence: number;
|
|
4232
4564
|
};
|
|
4233
4565
|
TokenNotFound: null;
|
|
4234
|
-
/**
|
|
4235
|
-
*
|
|
4566
|
+
/**
|
|
4567
|
+
* @description Solana base58 address with private key (must have private side so that can create session after).
|
|
4568
|
+
* Basically fix for solana-pubkey is array of bytes in serde https://github.com/anza-xyz/solana-sdk/pull/76
|
|
4569
|
+
*/
|
|
4236
4570
|
RegistrationKey: string;
|
|
4237
4571
|
User: {
|
|
4238
4572
|
accountIds: components["schemas"]["AccountId"][];
|
|
4239
|
-
sessions:
|
|
4573
|
+
sessions: {
|
|
4574
|
+
[key: string]: components["schemas"]["UserSession"];
|
|
4575
|
+
};
|
|
4240
4576
|
};
|
|
4241
4577
|
UserSession: {
|
|
4242
4578
|
pubkey: components["schemas"]["RegistrationKey"];
|
|
@@ -4267,8 +4603,10 @@ export interface components {
|
|
|
4267
4603
|
*/
|
|
4268
4604
|
nextStartInclusive?: number | null;
|
|
4269
4605
|
};
|
|
4270
|
-
/**
|
|
4271
|
-
*
|
|
4606
|
+
/**
|
|
4607
|
+
* @description Order summary.
|
|
4608
|
+
* Use order_id to application side join with trades as needed.
|
|
4609
|
+
*/
|
|
4272
4610
|
OrderInfo: {
|
|
4273
4611
|
addedAt: string;
|
|
4274
4612
|
updatedAt: string;
|
|
@@ -4329,8 +4667,10 @@ export interface components {
|
|
|
4329
4667
|
originalOrderSize: number;
|
|
4330
4668
|
clientOrderId?: string | null;
|
|
4331
4669
|
};
|
|
4332
|
-
/**
|
|
4333
|
-
*
|
|
4670
|
+
/**
|
|
4671
|
+
* @description Summary of position.
|
|
4672
|
+
* Does not provide details information about specific orders.
|
|
4673
|
+
*/
|
|
4334
4674
|
PositionSummary: {
|
|
4335
4675
|
/** Format: uint32 */
|
|
4336
4676
|
marketId: number;
|
|
@@ -4370,13 +4710,15 @@ export interface components {
|
|
|
4370
4710
|
/** Format: double */
|
|
4371
4711
|
amount: number;
|
|
4372
4712
|
};
|
|
4373
|
-
/**
|
|
4713
|
+
/**
|
|
4714
|
+
* @description Represents account health state.
|
|
4374
4715
|
* Each field expressed in USD basis points per account.
|
|
4375
4716
|
* For example:
|
|
4376
4717
|
* - value of 1.0000 means 1 USD.
|
|
4377
4718
|
* - value of 123.0004 means 123 USD and 0.04 cent.
|
|
4378
4719
|
*
|
|
4379
|
-
* All values are actual only at specific moment in time - because both market and oracle prices fluctuate all the time
|
|
4720
|
+
* All values are actual only at specific moment in time - because both market and oracle prices fluctuate all the time
|
|
4721
|
+
*/
|
|
4380
4722
|
AccountMarginsView: {
|
|
4381
4723
|
/**
|
|
4382
4724
|
* Format: double
|
|
@@ -4428,20 +4770,24 @@ export interface components {
|
|
|
4428
4770
|
* @description Similar to `pon`. See PN in MARKETS.md.
|
|
4429
4771
|
*/
|
|
4430
4772
|
pn: number;
|
|
4431
|
-
/**
|
|
4773
|
+
/**
|
|
4774
|
+
* @description See `bankruptcy` in MARKETS.md.
|
|
4432
4775
|
* In general happens if account does not have enough weighted tokens to
|
|
4433
|
-
* covert his debt and negative PnL.
|
|
4776
|
+
* covert his debt and negative PnL.
|
|
4777
|
+
*/
|
|
4434
4778
|
bankruptcy: boolean;
|
|
4435
4779
|
};
|
|
4436
4780
|
VaultViewState: {
|
|
4437
4781
|
state: components["schemas"]["VaultState"];
|
|
4438
4782
|
status: components["schemas"]["VaultStatus"];
|
|
4439
4783
|
};
|
|
4440
|
-
/**
|
|
4784
|
+
/**
|
|
4785
|
+
* @description Wrapper around one normal engine account.
|
|
4441
4786
|
*
|
|
4442
4787
|
* The account keeps balances, positions, orders, triggers, funding,
|
|
4443
4788
|
* liquidation, and account health. This state adds manager, config, shares,
|
|
4444
|
-
* epochs, and owner accounting.
|
|
4789
|
+
* epochs, and owner accounting.
|
|
4790
|
+
*/
|
|
4445
4791
|
VaultState: {
|
|
4446
4792
|
vault_id: components["schemas"]["VaultId"];
|
|
4447
4793
|
account_id: components["schemas"]["AccountId"];
|
|
@@ -4450,7 +4796,9 @@ export interface components {
|
|
|
4450
4796
|
/** Format: uint128 */
|
|
4451
4797
|
live_share_supply: number;
|
|
4452
4798
|
epochs: components["schemas"]["VaultEpochs"];
|
|
4453
|
-
users:
|
|
4799
|
+
users: {
|
|
4800
|
+
[key: string]: components["schemas"]["VaultUserState"];
|
|
4801
|
+
};
|
|
4454
4802
|
};
|
|
4455
4803
|
/**
|
|
4456
4804
|
* Format: uint32
|
|
@@ -4481,8 +4829,10 @@ export interface components {
|
|
|
4481
4829
|
* combined decimals (price_decimals + size_decimals).
|
|
4482
4830
|
*/
|
|
4483
4831
|
PositiveQuoteSize: number;
|
|
4484
|
-
/**
|
|
4485
|
-
*
|
|
4832
|
+
/**
|
|
4833
|
+
* @description Drawdown measures how far current price per share is below a stored epoch
|
|
4834
|
+
* price per share reference.
|
|
4835
|
+
*/
|
|
4486
4836
|
DrawdownConfig: {
|
|
4487
4837
|
/**
|
|
4488
4838
|
* Format: uint16
|
|
@@ -4495,21 +4845,12 @@ export interface components {
|
|
|
4495
4845
|
*/
|
|
4496
4846
|
freeze_bps: number;
|
|
4497
4847
|
};
|
|
4498
|
-
/**
|
|
4499
|
-
* Format: uint32
|
|
4500
|
-
* @description Positive duration, in units.
|
|
4501
|
-
* Zero is avoided as it will not lead to any change/progress,
|
|
4502
|
-
* which is what time for in protocols.
|
|
4503
|
-
* Is small enough to fit into any `Timestamp` change,
|
|
4504
|
-
* big enough to fit hundreds of years of weighted aggregation.
|
|
4505
|
-
* Also it uses 31 bit instead of 32, so can easy to do i32 arithmetics without any checkes on edge
|
|
4506
|
-
* I tried to use existing primitices directly, but that leads to more boilerplate on caller side and less type safety
|
|
4507
|
-
* (cannot limit what is possible with traits well).
|
|
4508
|
-
*/
|
|
4509
4848
|
Duration: number;
|
|
4510
|
-
/**
|
|
4849
|
+
/**
|
|
4850
|
+
* @description Aggregate withdrawal bucket and epoch state
|
|
4511
4851
|
*
|
|
4512
|
-
* Withdrawals are aggregate `Q_current`, `Q_previous`, and `Q_claimable`
|
|
4852
|
+
* Withdrawals are aggregate `Q_current`, `Q_previous`, and `Q_claimable`
|
|
4853
|
+
*/
|
|
4513
4854
|
VaultEpochs: {
|
|
4514
4855
|
current_epoch_id: components["schemas"]["EpochId"];
|
|
4515
4856
|
current_epoch_started_at: components["schemas"]["Timestamp"];
|
|
@@ -4523,9 +4864,11 @@ export interface components {
|
|
|
4523
4864
|
* @description EpochId is a 31 bit id for vault withdrawal epochs.
|
|
4524
4865
|
*/
|
|
4525
4866
|
EpochId: number;
|
|
4526
|
-
/**
|
|
4867
|
+
/**
|
|
4868
|
+
* @description Withdrawal buckets (accounting state)
|
|
4527
4869
|
*
|
|
4528
|
-
* Buckets store `Q_current`, `Q_previous`, and `Q_claimable`
|
|
4870
|
+
* Buckets store `Q_current`, `Q_previous`, and `Q_claimable`
|
|
4871
|
+
*/
|
|
4529
4872
|
WithdrawalBuckets: {
|
|
4530
4873
|
/** Format: uint64 */
|
|
4531
4874
|
current_epoch: number;
|
|
@@ -4534,11 +4877,13 @@ export interface components {
|
|
|
4534
4877
|
/** Format: uint64 */
|
|
4535
4878
|
claimable: number;
|
|
4536
4879
|
};
|
|
4537
|
-
/**
|
|
4880
|
+
/**
|
|
4881
|
+
* @description Price per share reference stored when an epoch closes.
|
|
4538
4882
|
*
|
|
4539
4883
|
* It stores `AV_safe,ref` and `S_ref`.
|
|
4540
4884
|
*
|
|
4541
|
-
* `PPS_ref = AV_safe,ref / S_ref`
|
|
4885
|
+
* `PPS_ref = AV_safe,ref / S_ref`
|
|
4886
|
+
*/
|
|
4542
4887
|
VaultPpsRef: {
|
|
4543
4888
|
epoch_id: components["schemas"]["EpochId"];
|
|
4544
4889
|
/**
|
|
@@ -4550,10 +4895,12 @@ export interface components {
|
|
|
4550
4895
|
/** Format: uint128 */
|
|
4551
4896
|
share_supply: number;
|
|
4552
4897
|
};
|
|
4553
|
-
/**
|
|
4898
|
+
/**
|
|
4899
|
+
* @description Owner share and withdrawal state
|
|
4554
4900
|
*
|
|
4555
4901
|
* Withdrawals are owner side `Q_owner,current`, `Q_owner,previous`, and
|
|
4556
|
-
* `Q_owner,claimable`
|
|
4902
|
+
* `Q_owner,claimable`
|
|
4903
|
+
*/
|
|
4557
4904
|
VaultUserState: {
|
|
4558
4905
|
/** Format: uint128 */
|
|
4559
4906
|
shares: number;
|
|
@@ -4601,9 +4948,11 @@ export interface components {
|
|
|
4601
4948
|
PageResult_for_ActionIdSubActionIdMarketIdCursor_and_AccountPnlInfo: {
|
|
4602
4949
|
/** @description Set of items for requested by query. */
|
|
4603
4950
|
items: components["schemas"]["AccountPnlInfo"][];
|
|
4604
|
-
/**
|
|
4951
|
+
/**
|
|
4952
|
+
* @description If request contains more data,
|
|
4605
4953
|
* this is the id is set with which next request should be performed to get next page.
|
|
4606
|
-
* If no more data, then it is undefined.
|
|
4954
|
+
* If no more data, then it is undefined.
|
|
4955
|
+
*/
|
|
4607
4956
|
nextStartInclusive?: components["schemas"]["ActionIdSubActionIdMarketIdCursor"] | null;
|
|
4608
4957
|
};
|
|
4609
4958
|
AccountPnlInfo: {
|
|
@@ -4680,9 +5029,11 @@ export interface components {
|
|
|
4680
5029
|
PageResult_for_ActionIdSubActionIdMarketIdCursor_and_AccountPositionHistoryInfo: {
|
|
4681
5030
|
/** @description Set of items for requested by query. */
|
|
4682
5031
|
items: components["schemas"]["AccountPositionHistoryInfo"][];
|
|
4683
|
-
/**
|
|
5032
|
+
/**
|
|
5033
|
+
* @description If request contains more data,
|
|
4684
5034
|
* this is the id is set with which next request should be performed to get next page.
|
|
4685
|
-
* If no more data, then it is undefined.
|
|
5035
|
+
* If no more data, then it is undefined.
|
|
5036
|
+
*/
|
|
4686
5037
|
nextStartInclusive?: components["schemas"]["ActionIdSubActionIdMarketIdCursor"] | null;
|
|
4687
5038
|
};
|
|
4688
5039
|
AccountPositionHistoryInfo: {
|
|
@@ -4778,9 +5129,11 @@ export interface components {
|
|
|
4778
5129
|
PageResult_for_string_and_AccountFundingInfo: {
|
|
4779
5130
|
/** @description Set of items for requested by query. */
|
|
4780
5131
|
items: components["schemas"]["AccountFundingInfo"][];
|
|
4781
|
-
/**
|
|
5132
|
+
/**
|
|
5133
|
+
* @description If request contains more data,
|
|
4782
5134
|
* this is the id is set with which next request should be performed to get next page.
|
|
4783
|
-
* If no more data, then it is undefined.
|
|
5135
|
+
* If no more data, then it is undefined.
|
|
5136
|
+
*/
|
|
4784
5137
|
nextStartInclusive?: string | null;
|
|
4785
5138
|
};
|
|
4786
5139
|
AccountFundingInfo: {
|
|
@@ -4875,9 +5228,11 @@ export interface components {
|
|
|
4875
5228
|
PageResult_for_AtomicActionIdCursor_and_PlaceTriggerRow: {
|
|
4876
5229
|
/** @description Set of items for requested by query. */
|
|
4877
5230
|
items: components["schemas"]["PlaceTriggerRow"][];
|
|
4878
|
-
/**
|
|
5231
|
+
/**
|
|
5232
|
+
* @description If request contains more data,
|
|
4879
5233
|
* this is the id is set with which next request should be performed to get next page.
|
|
4880
|
-
* If no more data, then it is undefined.
|
|
5234
|
+
* If no more data, then it is undefined.
|
|
5235
|
+
*/
|
|
4881
5236
|
nextStartInclusive?: components["schemas"]["AtomicActionIdCursor"] | null;
|
|
4882
5237
|
};
|
|
4883
5238
|
PlaceTriggerRow: {
|
|
@@ -4983,9 +5338,11 @@ export interface components {
|
|
|
4983
5338
|
trigger_price: components["schemas"]["PositivePriceMantissa"];
|
|
4984
5339
|
limits?: components["schemas"]["OrderLimits"] | null;
|
|
4985
5340
|
};
|
|
4986
|
-
/**
|
|
5341
|
+
/**
|
|
5342
|
+
* @description At least one limit to be presented.
|
|
4987
5343
|
* Logically limit is min value obtained executing.
|
|
4988
|
-
* `final_limit = min(base_size, quote_size, price)`
|
|
5344
|
+
* `final_limit = min(base_size, quote_size, price)`
|
|
5345
|
+
*/
|
|
4989
5346
|
OrderLimits: {
|
|
4990
5347
|
/**
|
|
4991
5348
|
* Format: uint64
|
|
@@ -5105,17 +5462,21 @@ export interface components {
|
|
|
5105
5462
|
le: components["schemas"]["Timestamp"];
|
|
5106
5463
|
};
|
|
5107
5464
|
StateDownloadMeta: {
|
|
5108
|
-
/**
|
|
5109
|
-
*
|
|
5465
|
+
/**
|
|
5466
|
+
* @description Hash of the state file.
|
|
5467
|
+
* Used as ETag.
|
|
5468
|
+
*/
|
|
5110
5469
|
hash: number[];
|
|
5111
5470
|
/**
|
|
5112
5471
|
* Format: uri
|
|
5113
5472
|
* @description Link to download the state file.
|
|
5114
5473
|
*/
|
|
5115
5474
|
link: string;
|
|
5116
|
-
/**
|
|
5475
|
+
/**
|
|
5476
|
+
* @description Version of binary which produced this state snapshot.
|
|
5117
5477
|
* So can decide whether it is compatible with client.
|
|
5118
|
-
* todo(repl): After upgrade release make it non-optional.
|
|
5478
|
+
* todo(repl): After upgrade release make it non-optional.
|
|
5479
|
+
*/
|
|
5119
5480
|
version?: components["schemas"]["BinaryId"] | null;
|
|
5120
5481
|
};
|
|
5121
5482
|
BinaryId: string;
|
|
@@ -5131,16 +5492,18 @@ export interface components {
|
|
|
5131
5492
|
action_id: number;
|
|
5132
5493
|
/** Format: uint64 */
|
|
5133
5494
|
action_nonce: number;
|
|
5134
|
-
timestamp: components["schemas"]["
|
|
5495
|
+
timestamp: components["schemas"]["TimestampMillis"];
|
|
5135
5496
|
paused: boolean;
|
|
5136
5497
|
};
|
|
5498
|
+
TimestampMillis: string;
|
|
5137
5499
|
StateHistInfo: {
|
|
5138
5500
|
versions: [
|
|
5139
5501
|
number,
|
|
5140
5502
|
components["schemas"]["ExecutableVersion"]
|
|
5141
5503
|
][];
|
|
5142
5504
|
};
|
|
5143
|
-
/**
|
|
5505
|
+
/**
|
|
5506
|
+
* @description Use 1/1_000_000 granularity (ppm)
|
|
5144
5507
|
*
|
|
5145
5508
|
* | ppm | decimal | percent |
|
|
5146
5509
|
* |------|----------|---------|
|
|
@@ -5152,7 +5515,8 @@ export interface components {
|
|
|
5152
5515
|
* | 500 | 0.0005 | 0.05% |
|
|
5153
5516
|
* | 1000 | 0.001 | 0.10% |
|
|
5154
5517
|
* | 5000 | 0.005 | 0.50% |
|
|
5155
|
-
* | 10000| 0.01 | 1.00% |
|
|
5518
|
+
* | 10000| 0.01 | 1.00% |
|
|
5519
|
+
*/
|
|
5156
5520
|
FeeTierConfig: {
|
|
5157
5521
|
/** Format: uint32 */
|
|
5158
5522
|
maker_fee_ppm: number;
|
|
@@ -5174,9 +5538,11 @@ export interface components {
|
|
|
5174
5538
|
PageResult_for_AccountId_and_AccountFeeTier: {
|
|
5175
5539
|
/** @description Set of items for requested by query. */
|
|
5176
5540
|
items: components["schemas"]["AccountFeeTier"][];
|
|
5177
|
-
/**
|
|
5541
|
+
/**
|
|
5542
|
+
* @description If request contains more data,
|
|
5178
5543
|
* this is the id is set with which next request should be performed to get next page.
|
|
5179
|
-
* If no more data, then it is undefined.
|
|
5544
|
+
* If no more data, then it is undefined.
|
|
5545
|
+
*/
|
|
5180
5546
|
nextStartInclusive?: components["schemas"]["AccountId"] | null;
|
|
5181
5547
|
};
|
|
5182
5548
|
AccountFeeTier: {
|
|
@@ -5312,9 +5678,15 @@ export interface components {
|
|
|
5312
5678
|
fromAccountId?: components["schemas"]["AccountId"] | null;
|
|
5313
5679
|
/** @description `None` when the destination is the fee vault (`Transfer` with `AccountRef::Special`). */
|
|
5314
5680
|
toAccountId?: components["schemas"]["AccountId"] | null;
|
|
5681
|
+
specialAccount?: components["schemas"]["SpecialAccount"] | null;
|
|
5315
5682
|
tokenId: components["schemas"]["TokenId"];
|
|
5316
5683
|
amount: components["schemas"]["PositiveBalanceMantissa"];
|
|
5317
5684
|
};
|
|
5685
|
+
/**
|
|
5686
|
+
* @description Unlike normal account, this account does not issues any action nor has key.
|
|
5687
|
+
* @enum {string}
|
|
5688
|
+
*/
|
|
5689
|
+
SpecialAccount: "FeeVault" | "ClaimVault";
|
|
5318
5690
|
/**
|
|
5319
5691
|
* Format: uint64
|
|
5320
5692
|
* @description 63 bit positive number of tokens.
|
|
@@ -5529,8 +5901,10 @@ export interface components {
|
|
|
5529
5901
|
/** Format: double */
|
|
5530
5902
|
bankruptcyPrice: number;
|
|
5531
5903
|
};
|
|
5532
|
-
/**
|
|
5533
|
-
*
|
|
5904
|
+
/**
|
|
5905
|
+
* @description TV config query response
|
|
5906
|
+
* https://www.tradingview.com/charting-library-docs/latest/connecting_data/UDF/#data-feed-configuration-data
|
|
5907
|
+
*/
|
|
5534
5908
|
TvConfigResponse: {
|
|
5535
5909
|
supported_resolutions: components["schemas"]["Resolution"][];
|
|
5536
5910
|
supports_group_request: boolean;
|
|
@@ -5585,13 +5959,15 @@ export interface components {
|
|
|
5585
5959
|
ticker: string;
|
|
5586
5960
|
type: string;
|
|
5587
5961
|
};
|
|
5588
|
-
/**
|
|
5962
|
+
/**
|
|
5963
|
+
* @description History query
|
|
5589
5964
|
* https://www.tradingview.com/charting-library-docs/latest/connecting_data/UDF/#bars
|
|
5590
5965
|
*
|
|
5591
5966
|
* # Extension:
|
|
5592
5967
|
* Accepts either:
|
|
5593
5968
|
* * `market_id` - raw market identifier
|
|
5594
|
-
* * `symbol` - market symbol from original spec, picks first market which matches it
|
|
5969
|
+
* * `symbol` - market symbol from original spec, picks first market which matches it
|
|
5970
|
+
*/
|
|
5595
5971
|
TvHistoryQuery: {
|
|
5596
5972
|
market_id?: number | null;
|
|
5597
5973
|
symbol?: string | null;
|
|
@@ -5625,8 +6001,10 @@ export interface components {
|
|
|
5625
6001
|
ok: {
|
|
5626
6002
|
d: components["schemas"]["TvQuotesItem"][];
|
|
5627
6003
|
};
|
|
5628
|
-
/**
|
|
5629
|
-
*
|
|
6004
|
+
/**
|
|
6005
|
+
* @description Quotes entry,
|
|
6006
|
+
* see https://www.tradingview.com/charting-library-docs/latest/api/modules/Datafeed/#quotedata
|
|
6007
|
+
*/
|
|
5630
6008
|
TvQuotesItem: {
|
|
5631
6009
|
n: string;
|
|
5632
6010
|
v: components["schemas"]["TvQuotesValues"];
|
|
@@ -5638,9 +6016,11 @@ export interface components {
|
|
|
5638
6016
|
/** @constant */
|
|
5639
6017
|
s: "error";
|
|
5640
6018
|
};
|
|
5641
|
-
/**
|
|
6019
|
+
/**
|
|
6020
|
+
* @description Datafeed quote values,
|
|
5642
6021
|
* see https://www.tradingview.com/charting-library-docs/latest/api/interfaces/Datafeed.DatafeedQuoteValues/ for details
|
|
5643
|
-
* Field renames are due to spec
|
|
6022
|
+
* Field renames are due to spec
|
|
6023
|
+
*/
|
|
5644
6024
|
TvQuotesValues: {
|
|
5645
6025
|
/**
|
|
5646
6026
|
* Format: double
|
|
@@ -5806,14 +6186,26 @@ export interface components {
|
|
|
5806
6186
|
/** Format: uint64 */
|
|
5807
6187
|
update_id: number;
|
|
5808
6188
|
account_id: components["schemas"]["AccountId"];
|
|
5809
|
-
fills:
|
|
5810
|
-
|
|
5811
|
-
|
|
6189
|
+
fills: {
|
|
6190
|
+
[key: string]: components["schemas"]["FillUpdate"];
|
|
6191
|
+
};
|
|
6192
|
+
places: {
|
|
6193
|
+
[key: string]: components["schemas"]["OrderUpdate"];
|
|
6194
|
+
};
|
|
6195
|
+
cancels: {
|
|
6196
|
+
[key: string]: components["schemas"]["OrderUpdate"];
|
|
6197
|
+
};
|
|
5812
6198
|
/** @description Reduce orders: fully cancelled or partially cancelled (shrunk in-place). */
|
|
5813
|
-
reduced_orders?:
|
|
6199
|
+
reduced_orders?: {
|
|
6200
|
+
[key: string]: components["schemas"]["OrderUpdate"];
|
|
6201
|
+
};
|
|
5814
6202
|
/** @description Maker orders removed by self-trade prevention. */
|
|
5815
|
-
self_trade_cancels?:
|
|
5816
|
-
|
|
6203
|
+
self_trade_cancels?: {
|
|
6204
|
+
[key: string]: components["schemas"]["OrderUpdate"];
|
|
6205
|
+
};
|
|
6206
|
+
balances: {
|
|
6207
|
+
[key: string]: number;
|
|
6208
|
+
};
|
|
5817
6209
|
};
|
|
5818
6210
|
FillUpdate: {
|
|
5819
6211
|
/**
|
|
@@ -5822,8 +6214,10 @@ export interface components {
|
|
|
5822
6214
|
*/
|
|
5823
6215
|
action_id: number;
|
|
5824
6216
|
physical_time: string;
|
|
5825
|
-
/**
|
|
5826
|
-
*
|
|
6217
|
+
/**
|
|
6218
|
+
* @description All trade ids folded into this update. Account fills are keyed by order id,
|
|
6219
|
+
* so a websocket batch may coalesce multiple fills for the same order.
|
|
6220
|
+
*/
|
|
5827
6221
|
trade_ids: number[];
|
|
5828
6222
|
side: components["schemas"]["Side"];
|
|
5829
6223
|
/** Format: double */
|
|
@@ -5909,8 +6303,10 @@ export interface components {
|
|
|
5909
6303
|
market_id: number;
|
|
5910
6304
|
requests: components["schemas"]["RfqFillRequestUpdate"][];
|
|
5911
6305
|
};
|
|
5912
|
-
/**
|
|
5913
|
-
*
|
|
6306
|
+
/**
|
|
6307
|
+
* @description When user asked for fill via RFQ,
|
|
6308
|
+
* this message send to all subscribed MMs (who can take user order).
|
|
6309
|
+
*/
|
|
5914
6310
|
RfqFillRequestUpdate: {
|
|
5915
6311
|
/** Format: uint64 */
|
|
5916
6312
|
updateId: number;
|
|
@@ -5932,7 +6328,6 @@ export interface components {
|
|
|
5932
6328
|
*/
|
|
5933
6329
|
timestamp: number;
|
|
5934
6330
|
};
|
|
5935
|
-
/** Format: uint32 */
|
|
5936
6331
|
DurationMillis: number;
|
|
5937
6332
|
CandleUpdate: {
|
|
5938
6333
|
/** @description TradingView resolution. */
|