Repository navigation
feat: v3 api docs - #50
Open
sainathr19 wants to merge 4 commits into
Open
sainathr19 wants to merge 4 commits into
sainathr19 wants to merge 4 commits into
Conversation
Documents all 18 v3 operations: the single call quote flow (POST /quote,
GET /quote/{id}, POST /index, GET /estimate) alongside the order,
catalogue, schema and monitoring endpoints v3 serves under its own prefix.
The API Reference tab is now versioned, with v3 as the current version and
v2 beside it. Also drops the root `openapi` key from docs.json, which made
the CLI try to validate docs.json itself as an OpenAPI document on every
dev, validate and broken-links run.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The spec documented GET /orders/{order}/instant-refund-hash, which has
never existed. The implementation has always taken the order id in a POST
body at POST /instant-refund-hash.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Adds a shared note to every v2 endpoint page pointing at the v3 reference, and saying plainly that v2 keeps working and that a date will be announced well before anything changes. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Chain, ChainWithId, Asset and AssetName were hand maintained in the v3 spec and had all drifted, on testnet as well as mainnet. They drive the playground's dropdowns, so a stale entry either hides a live route or offers one that 400s. scripts/sync_catalogue.py rebuilds all four from GET /chains and GET /assets, per environment, preferring v3 and falling back to v2 where v3 is not yet routed. A weekly workflow runs it with --check and fails when the spec and the API disagree. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.