[docs-agent] UTXO API: hardcode chain-specific server URLs (no network dropdown)#1310
[docs-agent] UTXO API: hardcode chain-specific server URLs (no network dropdown)#1310JackReacher0807 wants to merge 1 commit into
Conversation
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 59cc35c88f
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
| Broadcasts a signed raw Bitcoin transaction encoded as a hex string in the path. Returns | ||
| the transaction ID on success. The example value below is the hex of a confirmed Bitcoin |
There was a problem hiding this comment.
This Bitcoin-specific sendtx copy is still in the generic utxo spec, whose servers block still exposes bitcoincash-*, litecoin-*, and dogecoin-mainnet choices; content/docs.yml also still routes the Bitcoin UTXO page to api-name: utxo. In the rendered Bitcoin UTXO reference, users can therefore select a non-Bitcoin network but see/send Bitcoin-specific examples and guidance, so the original network-dropdown problem remains on this page rather than being fully hardcoded to Bitcoin.
Useful? React with 👍 / 👎.
…k dropdown)
On the Bitcoin Cash, Litecoin, and Dogecoin UTXO API method pages,
the rendered `Server` field currently exposes a dropdown of network
variants (mainnet/testnet) because the per-chain specs use a templated
`https://{network}.g.alchemy.com/v2` server URL with a `network` enum.
Even after the per-chain split (PR #1302) restricted each chain's enum
to that chain's own networks, the dropdown UI remained.
This change collapses each per-chain spec down to a single literal
server URL (`https://<chain>-mainnet.g.alchemy.com/v2`), removing the
dropdown entirely. Users now see exactly one hardcoded URL per chain
on every UTXO method page, matching Andra's requested behavior.
Testnet variants are dropped from the spec — users who need testnet
can swap the host manually in curl. The BTC shared spec
(`src/openapi/utxo/utxo.yaml`) is intentionally untouched in this
commit; it still exposes the 7-network enum.
Refs DOCS-83
Requested-by: @andra-catana
JackReacher0807
force-pushed
the
docs/utxo-hardcode-server-urls
branch
from
59cc35c to
8b64401
Compare
🔗 Preview Mode
|
🔍 Link CheckStatus: ⏭️ Skipped (no content changes) |
|
we decided to cancel this! |
2 participants
Summary
On the Bitcoin Cash, Litecoin, and Dogecoin UTXO API method pages, the rendered
Serverfield exposed a network-picker dropdown because each per-chain spec used a templatedhttps://{network}.g.alchemy.com/v2server URL with anetworkenum. Andra reported that even after PR #1302 restricted each chain's enum to that chain's own mainnet/testnet, the dropdown UI itself was still a distraction.This PR collapses each per-chain UTXO spec down to a single literal server URL (no variables, no enum, no dropdown):
src/openapi/utxo-bitcoincash/utxo-bitcoincash.yamlhttps://bitcoincash-mainnet.g.alchemy.com/v2src/openapi/utxo-litecoin/utxo-litecoin.yamlhttps://litecoin-mainnet.g.alchemy.com/v2src/openapi/utxo-dogecoin/utxo-dogecoin.yamlhttps://dogecoin-mainnet.g.alchemy.com/v2Trade-off
Testnet variants (
bitcoincash-testnet,litecoin-testnet) are dropped from the spec. Testnet users can swap the host manually in curl. The OpenAPI source still documents the path shapes correctly; only the host picker UI is removed.Out of scope
src/openapi/utxo/utxo.yamlis intentionally untouched. It still exposes the 7-network enum on the Bitcoin page. If reviewers want BTC pages to follow the same single-URL pattern, that's a follow-up.Validation
pnpm run validate:rest— all three modified specs validate cleanly.Linear
DOCS-83
Requested by
@andra-catana (via Slack thread)