Skip to content

Commit d3bd756

Browse files
Ndatta/issue 354 fix broken and duplicate links (#356)
* Fixed a few links * Fixed all broken link issues on NodeClient public API page * Fixed broken links of indexer http, node client private methods, and authenticators * Fixed all broken links issue * Fixed nodes related broken links
1 parent aac3e85 commit d3bd756

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+166
-46
lines changed

vocs-docs/docs/pages/indexer-client/http/accounts/get_fills.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ A promise that resolves to fill data containing details such as order ID, market
8484

8585
Examples: [Guide - Get Fills]
8686

87-
[Guide - Get Fills]: ../../interaction/data#get-fills-1
87+
[Guide - Get Fills]: ../../interaction/data/market#get-fills
8888

8989
[Address]: /types/address
9090
[SubaccountNumber]: /types/subaccount_number

vocs-docs/docs/pages/indexer-client/http/accounts/get_rewards.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ pub async fn get_rewards(
6363
[OK]: /types/ok
6464
[u32]: /types/u32
6565
[Address]: /types/address
66-
[HistoricalBlockTradingReward]: /types/get_historical_block_trading_reward
66+
[HistoricalBlockTradingReward]: /types/historical_block_trading_reward
6767
[Height]: /types/height
6868
[DateTime in UTC]: /types/date_time
6969
[Bad Request]: /types/bad-request

vocs-docs/docs/pages/indexer-client/http/accounts/list_orders.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -75,17 +75,17 @@ pub async fn list_orders(
7575

7676
#### Response
7777

78-
| Status | Meaning | Schema | Description |
79-
| ------ | ------------- | -------------------- | ------------------------------------- |
80-
| `200` | [OK] | [ListOrdersResponse] | The orders data. |
81-
| `400` | [Bad Request] | | The request was malformed or invalid. |
82-
| `404` | [Not Found] | | The subaccount was not found. |
78+
| Status | Meaning | Schema | Description |
79+
| ------ | ------------- | ------------------------ | ------------------------------------- |
80+
| `200` | [OK] | [OrderResponseObject] ⛁ | The orders data. |
81+
| `400` | [Bad Request] | | The request was malformed or invalid. |
82+
| `404` | [Not Found] | | The subaccount was not found. |
8383

8484
<Button href="https://indexer.v4testnet.dydx.exchange/v4/orders?address=dydx14zzueazeh0hj67cghhf9jypslcf9sh2n5k6art&subaccountNumber=0">API Example</Button>
8585

8686
Examples: [Guide - List Orders]
8787

88-
[Guide - List Orders]: ../../interaction/data#list-orders
88+
[Guide - List Orders]: ../../interaction/data/market#list-orders
8989

9090
[Address]: /types/address
9191
[SubaccountNumber]: /types/subaccount_number
@@ -96,7 +96,7 @@ Examples: [Guide - List Orders]
9696
[OrderType]: /types/order_type
9797
[Height]: /types/height
9898
[DateTime in UTC]: /types/date_time
99-
[ListOrdersResponse]: /types/list_orders_response
99+
[OrderResponseObject]: /types/order_response_object
100100
[OK]: /types/ok
101101
[Bad Request]: /types/bad-request
102102
[Not Found]: /types/not-found

vocs-docs/docs/pages/indexer-client/http/accounts/list_parent_positions.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,6 @@ pub async fn list_parent_positions(
5959
[PerpetualPositionResponseObject]: /types/perpetual_position_response_object
6060
[Address]: /types/address
6161
[u32]: /types/u32
62-
[OK]: /types/ok
6362
[PerpetualPositionResponseObject]: /types/perpetual_position_response_object
6463
[Bad Request]: /types/bad-request
6564
[Not Found]: /types/not-found

vocs-docs/docs/pages/indexer-client/http/accounts/list_positions.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ pub async fn list_positions(
7373

7474
Examples: [Guide - List Positions]
7575

76-
[Guide - List Positions]: ../../interaction/data#list-positions
76+
[Guide - List Positions]: ../../interaction/data/market#list-positions
7777
[Address]: /types/address
7878
[SubaccountNumber]: /types/subaccount_number
7979
[PerpetualPositionStatus]: /types/perpetual_position_status

vocs-docs/docs/pages/interaction/integration/integration-portfolio.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ This represents the user's maximum buying power if all remaining free collateral
4646
::::
4747

4848
(d) `Account level risk`
49+
The account-level risk is derived from Indexer data via the WebSocket `v4_parent_subaccounts` channel. [sample response](/types/parent_subaccounts_update_message).
4950
This metric represents the `percentage of the user's total collateral` that has been allocated to support open positions (also referred to as `margin`).
5051
The account-level risk is derived from Indexer data via the WebSocket `v4_parent_subaccounts` channel. [sample response](/types/parent_subaccounts_update_message).
5152

@@ -73,7 +74,7 @@ The resulting `total collateral` is then used to determine the `margin percentag
7374

7475
(e) `Historical PNL`. Indexer data [GetHistoricalPnlForParentSubaccount](/indexer-client/http#get-parent-historical-pnl). The chart shows the PNL tickets of the selected time range.
7576

76-
(f) `Position size, and position side` Indexer data from the websocket `v4_parent_subaccounts` channel. [sample response]([response](/types/parent_subaccounts_update_message)). Subaccount -> ChildSubaccounts -> openPerpetualPositions -> size/side.
77+
(f) `Position size, and position side` Indexer data from the websocket `v4_parent_subaccounts` channel. [sample response](/types/parent_subaccounts_update_message). Subaccount -> ChildSubaccounts -> openPerpetualPositions -> size/side.
7778

7879
(g) `Current oracle price`. From market data off the Websocket [v4-markets](/indexer-client/websockets#markets) channel.
7980

vocs-docs/docs/pages/node-client/authenticators/add.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Examples: [Python] | [TypeScript] | [Rust] | [Guide - Add an Authenticator]
5959
[Python]: https://github.com/dydxprotocol/v4-clients/blob/3e8c7e1b960291b7ef273962d374d9934a5c4d33/v4-client-py-v2/examples/authenticator_management.py#L53
6060
[TypeScript]: https://github.com/dydxprotocol/v4-clients/blob/3e8c7e1b960291b7ef273962d374d9934a5c4d33/v4-client-js/examples/permissioned_keys_example.ts#L58
6161
[Rust]: https://github.com/dydxprotocol/v4-clients/blob/3e8c7e1b960291b7ef273962d374d9934a5c4d33/v4-client-rs/client/examples/authenticator.rs#L79
62-
[Guide - Add an Authenticator]: ../../interaction/permissioned-key#add-the-authenticator
62+
[Guide - Add an Authenticator]: ../../interaction/permissioned-keys#add-the-authenticator
6363
[Wallet]: /types/wallet
6464
[Authenticator]: /types/authenticator
6565
[TxHash]: /types/tx_hash

vocs-docs/docs/pages/node-client/authenticators/remove.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,9 @@ Examples: [Python] | [TypeScript] | [Rust] | [Guide - Remove an Authenticator]
5555
[Python]: https://github.com/dydxprotocol/v4-clients/blob/3e8c7e1b960291b7ef273962d374d9934a5c4d33/v4-client-py-v2/examples/authenticator_management.py#L68
5656
[TypeScript]: https://github.com/dydxprotocol/v4-clients/blob/3e8c7e1b960291b7ef273962d374d9934a5c4d33/v4-client-js/examples/permissioned_keys_example.ts#L50
5757
[Rust]: https://github.com/dydxprotocol/v4-clients/blob/3e8c7e1b960291b7ef273962d374d9934a5c4d33/v4-client-rs/client/examples/authenticator.rs#L146
58-
[Guide - Remove an Authenticator]: ../../interaction/permissioned-keys/remove-the-authenticator
58+
[Guide - Remove an Authenticator]: ../../interaction/permissioned-keys#remove-the-authenticator
5959
[Wallet]: /types/wallet
6060
[TxHash]: /types/tx_hash
6161
[Bad Request]: /types/bad-request
62-
[Not Found]: /types/not-found
62+
[Not Found]: /types/not-found
63+
[OK]: /types/ok

vocs-docs/docs/pages/node-client/private/delegate.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ pub async fn delegate(
4242
| subaccount | query | [SubaccountInfo] | true | Subaccount number |
4343
| delegator | query | string | true | Delegator information |
4444
| validator | query | string | true | validator information |
45-
| amount | string | string | true | Amount to delegate |
45+
| amount | query | string | true | Amount to delegate |
4646
| broadcastMode | query | [BroadcastMode] | false | Mode of broadcast |
4747

4848
#### Response

vocs-docs/docs/pages/node-client/private/send_token.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@ pub async fn send_token(
5757
| Parameter | Location | Type | Required | Description |
5858
| ----------------- | --------- | --------- | --------- | ------------------------------------------------- |
5959
| `wallet` | query | [Wallet] | true | The wallet to use for signing the transaction. |
60-
| `sender` | query | [String] | true | The sender address. |
61-
| `recipient` | query | [String] | true | The recipient address. |
60+
| `sender` | query | String | true | The sender address. |
61+
| `recipient` | query | String | true | The recipient address. |
6262
| `quantums` | query | [i32] | true | The amount of quantums to send. |
6363
| `denomination` | query | [i32] | true | The denomination of the token. |
6464

@@ -75,7 +75,6 @@ Examples: [Rust]
7575

7676
[Wallet]: /types/wallet
7777
[TxHash]: /types/tx_hash
78-
[String]: /types/string
7978
[i32]: /types/i32
8079
[OK]: /types/ok
8180
[Bad Request]: /types/bad-request

0 commit comments

Comments
 (0)