docs: document x-api-experimental GuideStar-only header - #1149
Open
codyborn wants to merge 1 commit into
Open
Conversation
Adds a Quotes and Quoting FAQ entry for the x-api-experimental header shipped in Uniswap/backend#11443, so integrators know how to force a GuideStar-only quote and what its prerequisites and failure modes are.
|
Thanks for contributing to Uniswap Docs! 馃 Quick heads up on how this repo works: the docs you see on developers.uniswap.org are built from a separate source repo. When we accept a change here, we port it over there, so your fix might show up on the live site before it lands in this repo. Updates to this repo come in batches on a regular cadence. When yours is included, you'll be credited as a co-author on the commit, so the contribution counts on your GitHub profile and in Uniswap/docs. We review every PR but can't merge everything. Either way, someone from the docs team will follow up here once we've taken a look. One legal bit: by submitting a PR you agree your contribution is licensed under the repo's MIT license. |
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
1 participant
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.
Summary
Uniswap/backend#11443 shipped an
x-api-experimentalheader on/quotethat forces a GuideStar-only quote. The parameter itself is in the OpenAPI spec served attrade-api.gateway.uniswap.org/v1/api.json(so it already surfaces on the auto-generated/quotereference), but nothing in the FAQ pointed integrators at it.This adds one FAQ entry, in both the structured
faqs:frontmatter list and the matching<details>block, under Quotes and Quoting, right after the existing native-token FAQ (same section, same pattern as thex-erc20eth-enabledentry).Covers:
Test plan
trade-api.gateway.uniswap.org) thatx-api-experimental: true+x-universal-router-swapsteps: trueon a mainnet EXACT_INPUT quote returns a GuideStar-served quote, and that missing prerequisites 400 as documented.馃 Generated with Claude Code