Skip to content

feat: Update swagger.yaml to improve descriptions and add format spec #66

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
iamnivekx wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: Update swagger.yaml to improve descriptions and add format spec #66

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
52a83ad
feat: Update swagger.yaml to improve descriptions and add format spec…
iamnivekx May 23, 2025
fc03895
fix: Update integer format specifications in swagger.yaml for improve…
iamnivekx May 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions swagger.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ paths:
summary: quote
description: |
Request for a quote to be used in `POST /swap`

:::note
Refer to [Swap API doc](https://dev.jup.ag/docs/swap-api/get-quote) for more information
:::
Expand All @@ -50,7 +50,7 @@ paths:
- $ref: '#/components/parameters/DynamicSlippage'
responses:
'200':
description: "Successful response to be used in `/swap`"
description: 'Successful response to be used in `/swap`'
content:
application/json:
schema:
Expand All @@ -63,7 +63,7 @@ paths:
summary: swap
description: |
Request for a base64-encoded unsigned swap transaction based on the `/quote` response

:::note
Refer to [Swap API doc](https://dev.jup.ag/docs/swap-api/build-swap-transaction) for more information
:::
Expand All @@ -88,7 +88,7 @@ paths:
summary: swap-instructions
description: |
Request for swap instructions that you can use from the quote you get from `/quote`

:::note
Refer to [Swap API doc](https://dev.jup.ag/docs/swap-api/build-swap-transaction#build-your-own-transaction-with-instructions) for more information
:::
Expand Down Expand Up @@ -315,8 +315,10 @@ components:
description: |
- Maximum lamports to cap the priority fee estimation, to prevent overpaying
type: integer
format: uint64
jitoTipLamports:
type: integer
format: uint64
description: |
- Exact amount of tip to use in a tip instruction
- Refer to Jito docs on how to estimate the tip amount based on percentiles
Expand Down Expand Up @@ -360,11 +362,13 @@ components:
- `computeUnitLimit (1400000) * computeUnitPriceMicroLamports`
- We recommend using `prioritizationFeeLamports` and `dynamicComputeUnitLimit` instead of passing in your own compute unit price
type: integer
format: uint64
blockhashSlotsToExpiry:
description: |
- Pass in the number of slots we want the transaction to be valid for
- Example: If you pass in 10 slots, the transaction will be valid for ~400ms * 10 = approximately 4 seconds before it expires
type: integer
format: uint64
quoteResponse:
$ref: '#/components/schemas/QuoteResponse'

Expand All @@ -375,8 +379,10 @@ components:
type: string
lastValidBlockHeight:
type: integer
format: uint64
prioritizationFeeLamports:
type: integer
format: uint64
required:
- swapTransaction
- lastValidBlockHeight
Expand Down Expand Up @@ -473,11 +479,13 @@ components:
required: true
schema:
type: integer
format: uint64
SlippageParameter:
name: slippageBps
in: query
schema:
type: integer
format: int32
SwapModeParameter:
name: swapMode
description: |
Expand Down Expand Up @@ -550,6 +558,7 @@ components:
in: query
schema:
type: integer
format: int
default: 64
PlatformFeeBpsParameter:
name: platformFeeBps
Expand All @@ -559,6 +568,7 @@ components:
in: query
schema:
type: integer
format: int32
DynamicSlippage:
name: dynamicSlippage
description: |
Expand Down