docs: standardize graphql examples (#3391)

brad-dow · web-flow · commit d14a4c969b83 · 2025-04-11T14:31:47.000-05:00
* docs: standardize graphql api examples

Implemented the 3-tabbed panel for all GraphQL examples. This affected the following pages:
- Integration - Requirements - Assets
- Integration - Requirements - Peers
- Integration - Requirements - Wallet addresses
- Integration - Requirements - Sending fees

* docs: adding wrap to one of the json examples

* docs: fixed links

Changed hardcoded links to relative links

* docs: changing arguments to variables
diff --git a/packages/documentation/src/content/docs/admin/liquidity/asset-liquidity.mdx b/packages/documentation/src/content/docs/admin/liquidity/asset-liquidity.mdx
@@ -38,7 +38,7 @@ You can deposit and withdraw asset liquidity through the Rafiki Admin applicatio
     }
   ```
   </TabItem>
-  <TabItem label="Arguments">
+  <TabItem label="Variables">
     ```json
     {
       "input": {
@@ -78,7 +78,7 @@ mutation CreateAssetLiquidityWithdrawal($input: CreateAssetLiquidityWithdrawalIn
 ````
 
   </TabItem>
-  <TabItem label="Arguments">
+  <TabItem label="Variables">
   ```json
   {
     "input": {
diff --git a/packages/documentation/src/content/docs/admin/liquidity/payment-liquidity.mdx b/packages/documentation/src/content/docs/admin/liquidity/payment-liquidity.mdx
@@ -39,7 +39,7 @@ For more information about how Rafiki handles liquidity, see the [Accounting](/o
   }
   ```
   </TabItem>
-  <TabItem label="Arguments">
+  <TabItem label="Variables">
   ```json
   {
   "input": {
@@ -75,7 +75,7 @@ For more information about how Rafiki handles liquidity, see the [Accounting](/o
   }
   ```
   </TabItem>
-  <TabItem label="Arguments">
+  <TabItem label="Variables">
   ```json
   {
   "input": {
@@ -110,7 +110,7 @@ For more information about how Rafiki handles liquidity, see the [Accounting](/o
   }
   ```
   </TabItem>
-  <TabItem label="Arguments">
+  <TabItem label="Variables">
   ```json
   {
   "input": {
diff --git a/packages/documentation/src/content/docs/admin/liquidity/peer-liquidity.mdx b/packages/documentation/src/content/docs/admin/liquidity/peer-liquidity.mdx
@@ -36,7 +36,7 @@ You can deposit and withdraw peer liquidity through the Rafiki Admin application
   }
   ```
   </TabItem>
-  <TabItem label="Arguments">
+  <TabItem label="Variables">
   ```json
   {
     "input": {
@@ -77,7 +77,7 @@ For more information about this mutation's input object, see [`DepositPeerLiquid
   }
   ```
   </TabItem>
-  <TabItem label="Arguments">
+  <TabItem label="Variables">
   ```json
   {
     "input": {
diff --git a/packages/documentation/src/content/docs/admin/liquidity/two-phase-transfers.mdx b/packages/documentation/src/content/docs/admin/liquidity/two-phase-transfers.mdx
@@ -40,7 +40,7 @@ If the timeout interval passes before the transaction posts or is voided, the tr
   }
   ```
   </TabItem>
-  <TabItem label="Arguments">
+  <TabItem label="Variables">
   ```json
   {
   "input": {
@@ -76,7 +76,7 @@ If the timeout interval passes before the transaction posts or is voided, the tr
   }
   ```
   </TabItem>
-  <TabItem label="Arguments">
+  <TabItem label="Variables">
   ```json
   {
   "input": {
diff --git a/packages/documentation/src/content/docs/integration/requirements/assets.mdx b/packages/documentation/src/content/docs/integration/requirements/assets.mdx
@@ -1,72 +1,61 @@
 ---
 title: Assets
+tableOfContents:
+  maxHeadingLevel: 4
 ---
 
+import { Tabs, TabItem } from '@astrojs/starlight/components'
 import { Badge } from '@astrojs/starlight/components'
 import { Mermaid, CodeBlock, LinkOut } from '@interledger/docs-design-system'
 
 An asset represents an item of value that can be transferred via the Interledger Protocol. Assets in Rafiki can be added through the Backend Admin API or the [Rafiki Admin](/admin/admin-user-guide/#assets) application.
 
-## Add an asset using the `CreateAsset` GraphQL mutation
-
-<CodeBlock title='CreateAsset mutation'>
-
-```graphql
-mutation CreateAsset($input: CreateAssetInput!) {
-  createAsset(input: $input) {
-    code
-    success
-    message
-    asset {
-      id
-      code
-      scale
+## Add an asset
+
+<Tabs>
+  <TabItem label="Operation">
+    ```graphql
+    mutation CreateAsset($input: CreateAssetInput!) {
+      createAsset(input: $input) {
+        code
+        success
+        message
+        asset {
+          id
+          code
+          scale
+        }
+      }
     }
-  }
-}
-```
-
-</CodeBlock>
-
-### Example
-
-To add US dollars, for example, as an asset type to your Rafiki instance, call the `CreateAsset` mutation and pass the `input` parameters for the asset `code`, represented by its <LinkOut href="https://en.wikipedia.org/wiki/ISO_4217">ISO 4217 currency code</LinkOut> (USD), and `scale` variables as follows:
-
-<CodeBlock title='Example JSON request'>
-
-```json
-{
-  "input": {
-    "code": "USD",
-    "scale": 2
-  }
-}
-```
-
-</CodeBlock>
-
-| Variable | Description                                                                       |
-| -------- | --------------------------------------------------------------------------------- |
-| `code`   | The asset code, generally an ISO 4217 currency code where available.              |
-| `scale`  | Difference in order of magnitude between the standard unit and a fractional unit. |
-
-<CodeBlock title='Example JSON response'>
-
-```json
-{
-  "data": {
-    "createAsset": {
-      "code": "200",
-      "success": true,
-      "message": "Created Asset",
-      "asset": {
-        "id": "b3dffeda-1e0e-47d4-82a3-69b1a622eeb9",
+    ```
+  </TabItem>
+  <TabItem label="Variables">
+    ```json
+    {
+      "input": {
         "code": "USD",
         "scale": 2
       }
     }
-  }
-}
-```
-
-</CodeBlock>
+    ```
+    For more information about this mutation's input object, see [`CreateAssetInput`](/apis/graphql/backend/inputobjects/#createassetinput).
+  </TabItem>
+  <TabItem label="Response">
+    ```json
+    {
+      "data": {
+        "createAsset": {
+          "code": "200",
+          "success": true,
+          "message": "Created Asset",
+          "asset": {
+            "id": "b3dffeda-1e0e-47d4-82a3-69b1a622eeb9",
+            "code": "USD",
+            "scale": 2
+          }
+        }
+      }
+    }
+    ```
+  </TabItem>
+</Tabs>
diff --git a/packages/documentation/src/content/docs/integration/requirements/open-payments/grants-revoking.mdx b/packages/documentation/src/content/docs/integration/requirements/open-payments/grants-revoking.mdx
@@ -69,7 +69,7 @@ query Grants(
 ```
 </TabItem>
 
-<TabItem label='Arguments'>
+<TabItem label="Variables">
 ```json
 {
   "input": {
@@ -88,6 +88,7 @@ query Grants(
 }
 }
 ```
+For more information about this query's variables, see [`grants`](/apis/graphql/auth/queries/#grants).
 </TabItem>
 
 <TabItem label='Response'>
@@ -161,14 +162,15 @@ mutation revokeGrant($input: RevokeGrantInput!) {
 ```
 </TabItem>
 
-<TabItem label='Arguments'>
+<TabItem label="Variables">
 ```json
 {
     "input": {
         "grantId": "2117891e-4b89-42ae-984e-e0762d5888c1"
     }
 }
 ```
+For more information about this mutation's input object, see [`RevokeGrantInput`](/apis/graphql/auth/inputobjects/#revokegrantinput).
 </TabItem>
 
 <TabItem label='Response'>
diff --git a/packages/documentation/src/content/docs/integration/requirements/open-payments/wallet-keys.mdx b/packages/documentation/src/content/docs/integration/requirements/open-payments/wallet-keys.mdx
@@ -40,7 +40,7 @@ mutation CreateWalletAddressKey($input: CreateWalletAddressKeyInput!) {
 ```
 </TabItem>
 
-<TabItem label='Arguments'>
+<TabItem label="Variables">
 
 ```json
 {
@@ -127,7 +127,7 @@ mutation RevokeWalletAddressKey($input: RevokeWalletAddressKeyInput!) {
 
 </TabItem>
 
-<TabItem label = 'Arguments'>
+<TabItem label = 'Variables'>
 ```json
 {
   "input": {
diff --git a/packages/documentation/src/content/docs/integration/requirements/peers.mdx b/packages/documentation/src/content/docs/integration/requirements/peers.mdx
diff --git a/packages/documentation/src/content/docs/integration/requirements/sending-fees.mdx b/packages/documentation/src/content/docs/integration/requirements/sending-fees.mdx
diff --git a/packages/documentation/src/content/docs/integration/requirements/wallet-addresses.mdx b/packages/documentation/src/content/docs/integration/requirements/wallet-addresses.mdx

Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ You can deposit and withdraw asset liquidity through the Rafiki Admin applicatio`
`38`	`38`	`}`
`39`	`39`	```
`40`	`40`	`</TabItem>`
`41`		`- <TabItem label="Arguments">`
	`41`	`+ <TabItem label="Variables">`
`42`	`42`	```json
`43`	`43`	`{`
`44`	`44`	`"input": {`
`@@ -78,7 +78,7 @@ mutation CreateAssetLiquidityWithdrawal($input: CreateAssetLiquidityWithdrawalIn`
`78`	`78`	````
`79`	`79`
`80`	`80`	`</TabItem>`
`81`		`- <TabItem label="Arguments">`
	`81`	`+ <TabItem label="Variables">`
`82`	`82`	```json
`83`	`83`	`{`
`84`	`84`	`"input": {`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ For more information about how Rafiki handles liquidity, see the [Accounting](/o`
`39`	`39`	`}`
`40`	`40`	```
`41`	`41`	`</TabItem>`
`42`		`- <TabItem label="Arguments">`
	`42`	`+ <TabItem label="Variables">`
`43`	`43`	```json
`44`	`44`	`{`
`45`	`45`	`"input": {`
`@@ -75,7 +75,7 @@ For more information about how Rafiki handles liquidity, see the [Accounting](/o`
`75`	`75`	`}`
`76`	`76`	```
`77`	`77`	`</TabItem>`
`78`		`- <TabItem label="Arguments">`
	`78`	`+ <TabItem label="Variables">`
`79`	`79`	```json
`80`	`80`	`{`
`81`	`81`	`"input": {`
`@@ -110,7 +110,7 @@ For more information about how Rafiki handles liquidity, see the [Accounting](/o`
`110`	`110`	`}`
`111`	`111`	```
`112`	`112`	`</TabItem>`
`113`		`- <TabItem label="Arguments">`
	`113`	`+ <TabItem label="Variables">`
`114`	`114`	```json
`115`	`115`	`{`
`116`	`116`	`"input": {`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ You can deposit and withdraw peer liquidity through the Rafiki Admin application`
`36`	`36`	`}`
`37`	`37`	```
`38`	`38`	`</TabItem>`
`39`		`- <TabItem label="Arguments">`
	`39`	`+ <TabItem label="Variables">`
`40`	`40`	```json
`41`	`41`	`{`
`42`	`42`	`"input": {`
@@ -77,7 +77,7 @@ For more information about this mutation's input object, see [`DepositPeerLiquid
`77`	`77`	`}`
`78`	`78`	```
`79`	`79`	`</TabItem>`
`80`		`- <TabItem label="Arguments">`
	`80`	`+ <TabItem label="Variables">`
`81`	`81`	```json
`82`	`82`	`{`
`83`	`83`	`"input": {`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ If the timeout interval passes before the transaction posts or is voided, the tr`
`40`	`40`	`}`
`41`	`41`	```
`42`	`42`	`</TabItem>`
`43`		`- <TabItem label="Arguments">`
	`43`	`+ <TabItem label="Variables">`
`44`	`44`	```json
`45`	`45`	`{`
`46`	`46`	`"input": {`
`@@ -76,7 +76,7 @@ If the timeout interval passes before the transaction posts or is voided, the tr`
`76`	`76`	`}`
`77`	`77`	```
`78`	`78`	`</TabItem>`
`79`		`- <TabItem label="Arguments">`
	`79`	`+ <TabItem label="Variables">`
`80`	`80`	```json
`81`	`81`	`{`
`82`	`82`	`"input": {`
Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ query Grants(`
`69`	`69`	```
`70`	`70`	`</TabItem>`
`71`	`71`
`72`		`-<TabItem label='Arguments'>`
	`72`	`+<TabItem label="Variables">`
`73`	`73`	```json
`74`	`74`	`{`
`75`	`75`	`"input": {`
`@@ -88,6 +88,7 @@ query Grants(`
`88`	`88`	`}`
`89`	`89`	`}`
`90`	`90`	```
	`91`	+For more information about this query's variables, see [`grants`](/apis/graphql/auth/queries/#grants).
`91`	`92`	`</TabItem>`
`92`	`93`
`93`	`94`	`<TabItem label='Response'>`
`@@ -161,14 +162,15 @@ mutation revokeGrant($input: RevokeGrantInput!) {`
`161`	`162`	```
`162`	`163`	`</TabItem>`
`163`	`164`
`164`		`-<TabItem label='Arguments'>`
	`165`	`+<TabItem label="Variables">`
`165`	`166`	```json
`166`	`167`	`{`
`167`	`168`	`"input": {`
`168`	`169`	`"grantId": "2117891e-4b89-42ae-984e-e0762d5888c1"`
`169`	`170`	`}`
`170`	`171`	`}`
`171`	`172`	```
	`173`	+For more information about this mutation's input object, see [`RevokeGrantInput`](/apis/graphql/auth/inputobjects/#revokegrantinput).
`172`	`174`	`</TabItem>`
`173`	`175`
`174`	`176`	`<TabItem label='Response'>`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ mutation CreateWalletAddressKey($input: CreateWalletAddressKeyInput!) {`
`40`	`40`	```
`41`	`41`	`</TabItem>`
`42`	`42`
`43`		`-<TabItem label='Arguments'>`
	`43`	`+<TabItem label="Variables">`
`44`	`44`
`45`	`45`	```json
`46`	`46`	`{`
`@@ -127,7 +127,7 @@ mutation RevokeWalletAddressKey($input: RevokeWalletAddressKeyInput!) {`
`127`	`127`
`128`	`128`	`</TabItem>`
`129`	`129`
`130`		`-<TabItem label = 'Arguments'>`
	`130`	`+<TabItem label = 'Variables'>`
`131`	`131`	```json
`132`	`132`	`{`
`133`	`133`	`"input": {`