Skip to content

Commit a238ec7

Browse files
committed
docs: changing arguments to variables
1 parent 6d913bb commit a238ec7

10 files changed

Lines changed: 21 additions & 19 deletions

File tree

packages/documentation/src/content/docs/admin/liquidity/asset-liquidity.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ You can deposit and withdraw asset liquidity through the Rafiki Admin applicatio
3838
}
3939
```
4040
</TabItem>
41-
<TabItem label="Arguments">
41+
<TabItem label="Variables">
4242
```json
4343
{
4444
"input": {
@@ -78,7 +78,7 @@ mutation CreateAssetLiquidityWithdrawal($input: CreateAssetLiquidityWithdrawalIn
7878
````
7979

8080
</TabItem>
81-
<TabItem label="Arguments">
81+
<TabItem label="Variables">
8282
```json
8383
{
8484
"input": {

packages/documentation/src/content/docs/admin/liquidity/payment-liquidity.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ For more information about how Rafiki handles liquidity, see the [Accounting](/o
3939
}
4040
```
4141
</TabItem>
42-
<TabItem label="Arguments">
42+
<TabItem label="Variables">
4343
```json
4444
{
4545
"input": {
@@ -75,7 +75,7 @@ For more information about how Rafiki handles liquidity, see the [Accounting](/o
7575
}
7676
```
7777
</TabItem>
78-
<TabItem label="Arguments">
78+
<TabItem label="Variables">
7979
```json
8080
{
8181
"input": {
@@ -110,7 +110,7 @@ For more information about how Rafiki handles liquidity, see the [Accounting](/o
110110
}
111111
```
112112
</TabItem>
113-
<TabItem label="Arguments">
113+
<TabItem label="Variables">
114114
```json
115115
{
116116
"input": {

packages/documentation/src/content/docs/admin/liquidity/peer-liquidity.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ You can deposit and withdraw peer liquidity through the Rafiki Admin application
3636
}
3737
```
3838
</TabItem>
39-
<TabItem label="Arguments">
39+
<TabItem label="Variables">
4040
```json
4141
{
4242
"input": {
@@ -77,7 +77,7 @@ For more information about this mutation's input object, see [`DepositPeerLiquid
7777
}
7878
```
7979
</TabItem>
80-
<TabItem label="Arguments">
80+
<TabItem label="Variables">
8181
```json
8282
{
8383
"input": {

packages/documentation/src/content/docs/admin/liquidity/two-phase-transfers.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ If the timeout interval passes before the transaction posts or is voided, the tr
4040
}
4141
```
4242
</TabItem>
43-
<TabItem label="Arguments">
43+
<TabItem label="Variables">
4444
```json
4545
{
4646
"input": {
@@ -76,7 +76,7 @@ If the timeout interval passes before the transaction posts or is voided, the tr
7676
}
7777
```
7878
</TabItem>
79-
<TabItem label="Arguments">
79+
<TabItem label="Variables">
8080
```json
8181
{
8282
"input": {

packages/documentation/src/content/docs/integration/requirements/assets.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ An asset represents an item of value that can be transferred via the Interledger
2929
}
3030
```
3131
</TabItem>
32-
<TabItem label="Arguments">
32+
<TabItem label="Variables">
3333
```json
3434
{
3535
"input": {

packages/documentation/src/content/docs/integration/requirements/open-payments/grants-revoking.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ query Grants(
6969
```
7070
</TabItem>
7171

72-
<TabItem label='Arguments'>
72+
<TabItem label="Variables">
7373
```json
7474
{
7575
"input": {
@@ -88,6 +88,7 @@ query Grants(
8888
}
8989
}
9090
```
91+
For more information about this query's variables, see [`grants`](/apis/graphql/auth/queries/#grants).
9192
</TabItem>
9293

9394
<TabItem label='Response'>
@@ -161,14 +162,15 @@ mutation revokeGrant($input: RevokeGrantInput!) {
161162
```
162163
</TabItem>
163164

164-
<TabItem label='Arguments'>
165+
<TabItem label="Variables">
165166
```json
166167
{
167168
"input": {
168169
"grantId": "2117891e-4b89-42ae-984e-e0762d5888c1"
169170
}
170171
}
171172
```
173+
For more information about this mutation's input object, see [`RevokeGrantInput`](/apis/graphql/auth/inputobjects/#revokegrantinput).
172174
</TabItem>
173175

174176
<TabItem label='Response'>

packages/documentation/src/content/docs/integration/requirements/open-payments/wallet-keys.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ mutation CreateWalletAddressKey($input: CreateWalletAddressKeyInput!) {
4040
```
4141
</TabItem>
4242

43-
<TabItem label='Arguments'>
43+
<TabItem label="Variables">
4444

4545
```json
4646
{
@@ -127,7 +127,7 @@ mutation RevokeWalletAddressKey($input: RevokeWalletAddressKeyInput!) {
127127

128128
</TabItem>
129129

130-
<TabItem label = 'Arguments'>
130+
<TabItem label = 'Variables'>
131131
```json
132132
{
133133
"input": {

packages/documentation/src/content/docs/integration/requirements/peers.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ As mentioned in the prerequisites, you must add an asset to your Rafiki instance
9191
}
9292
```
9393
</TabItem>
94-
<TabItem label="Arguments">
94+
<TabItem label="Variables">
9595
```json wrap
9696
{
9797
"input": {
@@ -163,7 +163,7 @@ In this example we will update the peer we just created. Rather than change any
163163
}
164164
```
165165
</TabItem>
166-
<TabItem label="Arguments">
166+
<TabItem label="Variables">
167167
The input object for the update operation only requires that the `id` is present. All other variables are optional. For this example we will include the required `id` variable, as well as the optional variables of the fields we wish to update. In this case, `maxPacketAmount` and `liquidityThreshold`..
168168
```json
169169
{
@@ -225,7 +225,7 @@ Deleting a peer is permanent and cannot be reversed. If you delete a peer in err
225225
}
226226
```
227227
</TabItem>
228-
<TabItem label="Arguments">
228+
<TabItem label="Variables">
229229
```json
230230
{
231231
"input": {

packages/documentation/src/content/docs/integration/requirements/sending-fees.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ You have the option to charge sending fees, on top of any estimated network fees
3232
}
3333
```
3434
</TabItem>
35-
<TabItem label="Arguments">
35+
<TabItem label="Variables">
3636
For this example, let's assume your asset scale is 2. You'll charge a fixed fee of 100 (\$1.00) and a variable fee of 100 (1%).
3737
```json
3838
{

packages/documentation/src/content/docs/integration/requirements/wallet-addresses.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Ensure your script calls the `createWalletAddress` GraphQL mutation.
5555
```
5656
We strongly recommend you store at least the `walletAddress.id` in your internal database to be able to reference the account and wallet address later.
5757
</TabItem>
58-
<TabItem label="Arguments">
58+
<TabItem label="Variables">
5959
```json
6060
{
6161
"input": {

0 commit comments

Comments
 (0)