Skip to content

Commit 3730b83

Browse files
chore: update OpenAPI spec from 0x-labs (#177)
Co-authored-by: jlin27 <8042156+jlin27@users.noreply.github.com>
1 parent 835568b commit 3730b83

1 file changed

Lines changed: 26 additions & 26 deletions

File tree

fern/openapi.json

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
"exclusiveMinimum": true,
3838
"minimum": 0
3939
},
40-
"description": "Chain ID. See [here](https://0x.org/docs/developer-resources/supported-chains) for the list of supported chains",
40+
"description": "Chain ID. See [here](https://docs.0x.org/docs/introduction/supported-chains) for the list of supported chains",
4141
"example": 1
4242
},
4343
{
@@ -171,7 +171,7 @@
171171
"enum": ["true", "false"],
172172
"default": "false"
173173
},
174-
"description": "If set to `true`, the taker's entire `sellToken` balance will be sold during trade execution. The `sellAmount` should be the maximum estimated value, as close as possible to the actual taker's balance to ensure the best routing. Selling more than the `sellAmount` may cause the trade to revert. This feature is designed for cases where the precise sell amount is determined during execution. Learn more [here](https://0x.org/docs/0x-swap-api/advanced-topics/sell-entire-balance)."
174+
"description": "If set to `true`, the taker's entire `sellToken` balance will be sold during trade execution. The `sellAmount` should be the maximum estimated value, as close as possible to the actual taker's balance to ensure the best routing. Selling more than the `sellAmount` may cause the trade to revert. This feature is designed for cases where the precise sell amount is determined during execution. Learn more [here](https://docs.0x.org/docs/0x-swap-api/additional-topics/sell-entire-balance)."
175175
}
176176
],
177177
"responses": {
@@ -423,7 +423,7 @@
423423
"invalidSourcesPassed": {
424424
"type": "array",
425425
"items": { "type": "string" },
426-
"description": "A list of invalid sources present in `excludedSources` request. See https://api.0x.org/sources?chainId= with the desired chain's ID for the list of valid sources"
426+
"description": "A list of invalid sources present in `excludedSources` request. See `https://api.0x.org/sources?chainId=` with the desired chain's ID for the list of valid sources"
427427
}
428428
},
429429
"required": [
@@ -842,7 +842,7 @@
842842
"exclusiveMinimum": true,
843843
"minimum": 0
844844
},
845-
"description": "Chain ID. See [here](https://0x.org/docs/developer-resources/supported-chains) for the list of supported chains",
845+
"description": "Chain ID. See [here](https://docs.0x.org/docs/introduction/supported-chains) for the list of supported chains",
846846
"example": 1
847847
},
848848
{
@@ -965,7 +965,7 @@
965965
"in": "query",
966966
"required": false,
967967
"schema": { "type": "string" },
968-
"description": "Liquidity sources e.g. Uniswap_V3, SushiSwap, 0x_RFQ to exclude from the provided quote. See https://api.0x.org/sources?chainId=<chain_id> with the desired chain's ID for a full list of sources. Separate multiple sources with a comma"
968+
"description": "Liquidity sources e.g. Uniswap_V3, SushiSwap, 0x_RFQ to exclude from the provided quote. `See https://api.0x.org/sources?chainId=<chain_id>` with the desired chain's ID for a full list of sources. Separate multiple sources with a comma"
969969
},
970970
{
971971
"name": "sellEntireBalance",
@@ -976,7 +976,7 @@
976976
"enum": ["true", "false"],
977977
"default": "false"
978978
},
979-
"description": "If set to `true`, the taker's entire `sellToken` balance will be sold during trade execution. The `sellAmount` should be the maximum estimated value, as close as possible to the actual taker's balance to ensure the best routing. Selling more than the `sellAmount` may cause the trade to revert. This feature is designed for cases where the precise sell amount is determined during execution. Learn more [here](https://0x.org/docs/0x-swap-api/advanced-topics/sell-entire-balance)."
979+
"description": "If set to `true`, the taker's entire `sellToken` balance will be sold during trade execution. The `sellAmount` should be the maximum estimated value, as close as possible to the actual taker's balance to ensure the best routing. Selling more than the `sellAmount` may cause the trade to revert. This feature is designed for cases where the precise sell amount is determined during execution. Learn more [here](https://docs.0x.org/docs/0x-swap-api/additional-topics/sell-entire-balance)."
980980
}
981981
],
982982
"responses": {
@@ -1206,7 +1206,7 @@
12061206
"invalidSourcesPassed": {
12071207
"type": "array",
12081208
"items": { "type": "string" },
1209-
"description": "A list of invalid sources present in `excludedSources` request. See https://api.0x.org/sources?chainId= with the desired chain's ID for the list of valid sources"
1209+
"description": "A list of invalid sources present in `excludedSources` request. See `https://api.0x.org/sources?chainId=` with the desired chain's ID for the list of valid sources"
12101210
}
12111211
},
12121212
"required": [
@@ -1683,7 +1683,7 @@
16831683
"exclusiveMinimum": true,
16841684
"minimum": 0
16851685
},
1686-
"description": "Chain ID. See [here](https://0x.org/docs/developer-resources/supported-chains) for the list of supported chains",
1686+
"description": "Chain ID. See [here](https://docs.0x.org/docs/introduction/supported-chains) for the list of supported chains",
16871687
"example": 1
16881688
},
16891689
{
@@ -1817,7 +1817,7 @@
18171817
"enum": ["true", "false"],
18181818
"default": "false"
18191819
},
1820-
"description": "If set to `true`, the taker's entire `sellToken` balance will be sold during trade execution. The `sellAmount` should be the maximum estimated value, as close as possible to the actual taker's balance to ensure the best routing. Selling more than the `sellAmount` may cause the trade to revert. This feature is designed for cases where the precise sell amount is determined during execution. Learn more [here](https://0x.org/docs/0x-swap-api/advanced-topics/sell-entire-balance)."
1820+
"description": "If set to `true`, the taker's entire `sellToken` balance will be sold during trade execution. The `sellAmount` should be the maximum estimated value, as close as possible to the actual taker's balance to ensure the best routing. Selling more than the `sellAmount` may cause the trade to revert. This feature is designed for cases where the precise sell amount is determined during execution. Learn more [here](https://docs.0x.org/docs/0x-swap-api/additional-topics/sell-entire-balance)."
18211821
}
18221822
],
18231823
"responses": {
@@ -2069,7 +2069,7 @@
20692069
"invalidSourcesPassed": {
20702070
"type": "array",
20712071
"items": { "type": "string" },
2072-
"description": "A list of invalid sources present in `excludedSources` request. See https://api.0x.org/sources?chainId= with the desired chain's ID for the list of valid sources"
2072+
"description": "A list of invalid sources present in `excludedSources` request. See `https://api.0x.org/sources?chainId=` with the desired chain's ID for the list of valid sources"
20732073
}
20742074
},
20752075
"required": [
@@ -2488,7 +2488,7 @@
24882488
"exclusiveMinimum": true,
24892489
"minimum": 0
24902490
},
2491-
"description": "Chain ID. See [here](https://0x.org/docs/developer-resources/supported-chains) for the list of supported chains",
2491+
"description": "Chain ID. See [here](https://docs.0x.org/docs/introduction/supported-chains) for the list of supported chains",
24922492
"example": 1
24932493
},
24942494
{
@@ -2611,7 +2611,7 @@
26112611
"in": "query",
26122612
"required": false,
26132613
"schema": { "type": "string" },
2614-
"description": "Liquidity sources e.g. Uniswap_V3, SushiSwap, 0x_RFQ to exclude from the provided quote. See https://api.0x.org/sources?chainId=<chain_id> with the desired chain's ID for a full list of sources. Separate multiple sources with a comma"
2614+
"description": "Liquidity sources e.g. Uniswap_V3, SushiSwap, 0x_RFQ to exclude from the provided quote. `See https://api.0x.org/sources?chainId=<chain_id>` with the desired chain's ID for a full list of sources. Separate multiple sources with a comma"
26152615
},
26162616
{
26172617
"name": "sellEntireBalance",
@@ -2622,7 +2622,7 @@
26222622
"enum": ["true", "false"],
26232623
"default": "false"
26242624
},
2625-
"description": "If set to `true`, the taker's entire `sellToken` balance will be sold during trade execution. The `sellAmount` should be the maximum estimated value, as close as possible to the actual taker's balance to ensure the best routing. Selling more than the `sellAmount` may cause the trade to revert. This feature is designed for cases where the precise sell amount is determined during execution. Learn more [here](https://0x.org/docs/0x-swap-api/advanced-topics/sell-entire-balance)."
2625+
"description": "If set to `true`, the taker's entire `sellToken` balance will be sold during trade execution. The `sellAmount` should be the maximum estimated value, as close as possible to the actual taker's balance to ensure the best routing. Selling more than the `sellAmount` may cause the trade to revert. This feature is designed for cases where the precise sell amount is determined during execution. Learn more [here](https://docs.0x.org/docs/0x-swap-api/additional-topics/sell-entire-balance)."
26262626
}
26272627
],
26282628
"responses": {
@@ -2852,7 +2852,7 @@
28522852
"invalidSourcesPassed": {
28532853
"type": "array",
28542854
"items": { "type": "string" },
2855-
"description": "A list of invalid sources present in `excludedSources` request. See https://api.0x.org/sources?chainId= with the desired chain's ID for the list of valid sources"
2855+
"description": "A list of invalid sources present in `excludedSources` request. See `https://api.0x.org/sources?chainId=` with the desired chain's ID for the list of valid sources"
28562856
}
28572857
},
28582858
"required": [
@@ -3533,7 +3533,7 @@
35333533
"exclusiveMinimum": true,
35343534
"minimum": 0
35353535
},
3536-
"description": "Chain ID. See [here](https://0x.org/docs/developer-resources/supported-chains) for the list of supported chains",
3536+
"description": "Chain ID. See [here](https://docs.0x.org/docs/introduction/supported-chains) for the list of supported chains",
35373537
"example": 1
35383538
},
35393539
{
@@ -3637,7 +3637,7 @@
36373637
"in": "query",
36383638
"required": false,
36393639
"schema": { "type": "string" },
3640-
"description": "Liquidity sources e.g. Uniswap_V3, SushiSwap, 0x_RFQ to exclude from the provided quote. See https://api.0x.org/sources?chainId=<chain_id> with the desired chain's ID for a full list of sources. Separate multiple sources with a comma"
3640+
"description": "Liquidity sources e.g. Uniswap_V3, SushiSwap, 0x_RFQ to exclude from the provided quote. `See https://api.0x.org/sources?chainId=<chain_id>` with the desired chain's ID for a full list of sources. Separate multiple sources with a comma"
36413641
}
36423642
],
36433643
"responses": {
@@ -3868,7 +3868,7 @@
38683868
"invalidSourcesPassed": {
38693869
"type": "array",
38703870
"items": { "type": "string" },
3871-
"description": "A list of invalid sources present in `excludedSources` request. See https://api.0x.org/sources?chainId= with the desired chain's ID for the list of valid sources"
3871+
"description": "A list of invalid sources present in `excludedSources` request. See `https://api.0x.org/sources?chainId=` with the desired chain's ID for the list of valid sources"
38723872
}
38733873
},
38743874
"required": [
@@ -4290,7 +4290,7 @@
42904290
"exclusiveMinimum": true,
42914291
"minimum": 0
42924292
},
4293-
"description": "Chain ID. See [here](https://0x.org/docs/developer-resources/supported-chains) for the list of supported chains",
4293+
"description": "Chain ID. See [here](https://docs.0x.org/docs/introduction/supported-chains) for the list of supported chains",
42944294
"example": 1
42954295
},
42964296
{
@@ -4394,7 +4394,7 @@
43944394
"in": "query",
43954395
"required": false,
43964396
"schema": { "type": "string" },
4397-
"description": "Liquidity sources e.g. Uniswap_V3, SushiSwap, 0x_RFQ to exclude from the provided quote. See https://api.0x.org/sources?chainId=<chain_id> with the desired chain's ID for a full list of sources. Separate multiple sources with a comma"
4397+
"description": "Liquidity sources e.g. Uniswap_V3, SushiSwap, 0x_RFQ to exclude from the provided quote. See `https://api.0x.org/sources?chainId=<chain_id>` with the desired chain's ID for a full list of sources. Separate multiple sources with a comma"
43984398
}
43994399
],
44004400
"responses": {
@@ -4709,7 +4709,7 @@
47094709
"invalidSourcesPassed": {
47104710
"type": "array",
47114711
"items": { "type": "string" },
4712-
"description": "A list of invalid sources present in `excludedSources` request. See https://api.0x.org/sources?chainId= with the desired chain's ID for the list of valid sources"
4712+
"description": "A list of invalid sources present in `excludedSources` request. See `https://api.0x.org/sources?chainId=` with the desired chain's ID for the list of valid sources"
47134713
}
47144714
},
47154715
"required": [
@@ -5298,7 +5298,7 @@
52985298
"type": "integer",
52995299
"exclusiveMinimum": true,
53005300
"minimum": 0,
5301-
"description": "Chain ID. See [here](https://0x.org/docs/developer-resources/supported-chains) for the list of supported chains"
5301+
"description": "Chain ID. See [here](https://docs.0x.org/docs/introduction/supported-chains) for the list of supported chains"
53025302
},
53035303
"approval": {
53045304
"type": "object",
@@ -6015,7 +6015,7 @@
60156015
"exclusiveMinimum": true,
60166016
"minimum": 0
60176017
},
6018-
"description": " [here](https://0x.org/docs/next/developer-resources/supported-chains) for the list of supported chains",
6018+
"description": " [here](https://docs.0x.org/docs/introduction/supported-chains) for the list of supported chains",
60196019
"example": 8453
60206020
},
60216021
{
@@ -6254,7 +6254,7 @@
62546254
"exclusiveMinimum": true,
62556255
"minimum": 0
62566256
},
6257-
"description": "Chain ID. See [here](https://0x.org/docs/developer-resources/supported-chains) for the list of supported chains",
6257+
"description": "Chain ID. See [here](https://docs.0x.org/docs/introduction/supported-chains) for the list of supported chains",
62586258
"example": 8453
62596259
}
62606260
],
@@ -6434,7 +6434,7 @@
64346434
"exclusiveMinimum": true,
64356435
"minimum": 0
64366436
},
6437-
"description": "Chain ID. See [here](https://0x.org/docs/developer-resources/supported-chains) for the list of supported chains",
6437+
"description": "Chain ID. See [here](https://docs.0x.org/docs/introduction/supported-chains) for the list of supported chains",
64386438
"example": 1
64396439
}
64406440
],
@@ -6518,7 +6518,7 @@
65186518
"get": {
65196519
"operationId": "tradeAnalytics::swap",
65206520
"summary": "getSwapTrades",
6521-
"description": "Get the list of completed swap trades. Returns a maximum of 200 trades per request. Visit [here](https://docs.0x.org/trade-analytics-api/introduction) for more details about how the API works.",
6521+
"description": "Get the list of completed swap trades. Returns a maximum of 200 trades per request. Visit [here](https://docs.0x.org/docs/trade-analytics-api/introduction) for more details about how the API works.",
65226522
"tags": ["Trade Analytics"],
65236523
"parameters": [
65246524
{
@@ -6844,7 +6844,7 @@
68446844
"get": {
68456845
"operationId": "tradeAnalytics::gasless",
68466846
"summary": "getGaslessTrades",
6847-
"description": "Get the list of completed gasless trades. Returns a maximum of 200 trades per request. Visit [here](https://docs.0x.org/trade-analytics-api/introduction) for more details about how the API works.",
6847+
"description": "Get the list of completed gasless trades. Returns a maximum of 200 trades per request. Visit [here](https://docs.0x.org/docs/trade-analytics-api/introduction) for more details about how the API works.",
68486848
"tags": ["Trade Analytics"],
68496849
"parameters": [
68506850
{

0 commit comments

Comments
 (0)