[docs-agent] Document network support on get-transfers-by-address - #1643
alchemy-bot wants to merge 2 commits into
Conversation
Add an explicit supported-networks table (14 EVM networks) to the `networks` field description in `TransfersByAddressRequest`, replacing the generic "Ethereum and many EVM chains" copy with the concrete list Brian confirmed. The dashboard.alchemy.com/chains link on that field was misleading (it lists every Alchemy-supported chain, not just the ones this endpoint fans out to). Also add a note on the `category` field that `internal` is only supported on Ethereum Mainnet, Base Mainnet, Polygon Mainnet, Arc Mainnet, and Arc Testnet. All other categories are supported on every network in the table. Requested-by: @brianluong
🔗 Preview Mode
|
![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: 9945a6f96a
ℹ️ 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".
| | Network | Slug | | ||
| | ------------------- | --------------------- | |
There was a problem hiding this comment.
Because this description uses YAML's folded > scalar, the newline after every table row is replaced with a space when the OpenAPI document is parsed. The resulting description contains the header, separator, and all network entries on one line, so Markdown renderers cannot recognize the intended table. Use a literal block scalar such as | to preserve the row boundaries.
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
Addressed in 9883d35 by removing the description-embedded table entirely and moving the supported values to an items.enum on the networks field, per @dslovinsky's follow-up feedback. Same fix covers the folded-scalar collapsing issue you flagged.
Per @dslovinsky's review feedback (and Codex's P2 comment): the folded-YAML markdown table collapsed to a single line in Fern's rendering, and using free-form text to describe enumerated API values is the wrong shape anyway. Replaced the table with an `enum:` on `items:` inside the `networks` field, which is the structurally correct way to express the accepted values and lets Fern render a dropdown / validate at spec time. Kept the top-level endpoint description's "14 EVM networks" summary and the `internal`-category caveat (that constraint is cross-field and can't be expressed via enum). Requested-by: @brianluong
This branch has not been deployed
2 participants
Summary
Adds an explicit list of the 14 EVM networks supported by the Portfolio Transfers By Wallet (Beta) endpoint (
get-transfers-by-address), plus a note that theinternalcategory has a narrower support matrix than the other categories.Changes in
src/openapi/portfolio/portfolio.yaml(TransfersByAddressRequestschema):networksfield description — replaced the generic "Reach out if you need more. Find network enums here" copy with an explicit two-column table (Network → REST slug) covering all 14 supported networks: Ethereum, Polygon, Arbitrum, Optimism, Base, BNB, Celo, Ronin, Monad (mainnet + testnet), Robinhood (mainnet + testnet), and Arc (mainnet + testnet). The old dashboard link was misleading because it lists every Alchemy-supported chain, not the subset this endpoint fans out to.categoryfield description — added a note thatinternalis only supported on Ethereum Mainnet, Base Mainnet, Polygon Mainnet, Arc Mainnet, and Arc Testnet. All other categories (external,erc20,erc721,erc1155,specialnft) work on every network in thenetworkstable.Changes in
src/openapi/portfolio/transfers/by-address.yaml:networksfield's table, plus the sameinternal-category caveat at endpoint level so it's visible before users expand the request body accordion.Verified with
pnpm run validate:rest(clean; 9 pre-existing warnings on the portfolio spec, none from this diff) andnpx prettier --check.Requested by
@brianluong (via Slack thread)