Skip to content

Commit

Permalink
adding swagger
Browse files Browse the repository at this point in the history
  • Loading branch information
abhisom2912 committed Nov 15, 2024
1 parent c977550 commit 25a200b
Show file tree
Hide file tree
Showing 6 changed files with 798 additions and 4 deletions.
7 changes: 7 additions & 0 deletions docs/router-pay/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,13 @@ Router Pay (referred to as ISA as well) addresses these issues by offering a use
<Section title="Integrating Router Pay" id="web-sdks" hasSubSections >

<Section>
<Card
title="API endpoints"
description="Router Pay API endpoints"
to="/api/?v=ROUTER-PAY"
icon={<Tscodegen />}
svgFile="/icons/api.svg"
/>
<Card
title="Add ISA to your dApp"
description="Integrate Router Pay and provide a no sign-up UX to users"
Expand Down
7 changes: 7 additions & 0 deletions docs/router-pay/integrate-router-pay/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,13 @@ Router Pay provides the capability to generate a ISA for any dApp which wants to
## Integration

<Section>
<Card
title="API endpoints"
description="Router Pay API endpoints"
to="/api/?v=ROUTER-PAY"
icon={<Tscodegen />}
svgFile="/icons/api.svg"
/>
<Card
title="Add ISA to your dApp"
description="Integrate Router Pay and provide a no sign-up UX to users"
Expand Down
6 changes: 4 additions & 2 deletions docs/router-pay/integrate-router-pay/dapp-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Integration of Router Pay is a 2 step process -
2. **Check status:** API to check the status of the transaction.

:::info
BASE URL = https://btc-testnet.poap-nft.routernitro.com/internal
BASE URL = https://api.pay.routerprotocol.com
:::

## Generate Deposit Address
Expand All @@ -28,6 +28,7 @@ The below end point will generate the deposit address where the end user can sen
| chainId | string | Chain Id on which the user will be sending funds (should be the same where the contract has to be called) |
| amount | string | Amount to be used for executing the calldata |
| partnerId | number | OPTIONAL: Partner identification number |
| bufferTimeInSec | number | OPTIONAL: In case a custom expiration time is needed for the generated address |


**Sample Request**
Expand All @@ -39,7 +40,8 @@ The below end point will generate the deposit address where the end user can sen
"refundAddress": "0xf79D7E74304AF49748A4d77d4B64eeEE84d131cf",
"chainId": "43113",
"amount": "100000000000000023001",
"partnerId": 12
"partnerId": 12,
"bufferTimeInSec": 2000
}
```

Expand Down
2 changes: 1 addition & 1 deletion docs/router-pay/integrate-router-pay/router-nitro.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Integration of Router Nitro which also has ISA capabilities is a 2 step process
2. **Check status:** API to check the status of the transaction.

:::info
BASE URL = https://btc-testnet.poap-nft.routernitro.com/internal
BASE URL = https://api.pay.routerprotocol.com
:::


Expand Down
2 changes: 1 addition & 1 deletion static/api/PATHFINDER.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ paths:
schema:
type: string
example: "43113"
description: "Token address of the asset you wish to receive on the destination chain."
description: "Network ID of the destination chain (eg: 43113 for fuji)"
- in: query
name: partnerId
required: false
Expand Down
Loading

0 comments on commit 25a200b

Please sign in to comment.