docs: Fix token list structure documentation#139
Conversation
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Greptile SummaryThis PR fixes the token list structure documentation by adding previously missing required fields and correcting the JSON syntax. Changes made:
The updated structure now correctly matches the actual token list format used by the Request Network API, as confirmed by cross-referencing with Confidence Score: 5/5
Important Files Changed
Sequence DiagramsequenceDiagram
participant Dev as Developer
participant Docs as Token List Docs
participant API as Request Network API
participant SDK as Request Network SDK
participant User as Documentation Reader
Note over Dev,Docs: Documentation Fix Process
Dev->>Docs: Identify missing fields in token structure
Dev->>API: Cross-reference with API docs
API-->>Dev: Confirm structure includes network, type, hash
Dev->>SDK: Check source code for field definitions
SDK-->>Dev: Verify currency-types.ts structure
Dev->>Docs: Update JSON example with complete fields
Dev->>Docs: Add field descriptions table
Dev->>Docs: Add SDK source code link
Dev->>Docs: Replace placeholder with real USDC token
Dev->>Docs: Fix JSON syntax (missing comma)
Note over User,Docs: Documentation Usage
User->>Docs: Read token structure documentation
Docs-->>User: Show complete token example
User->>Docs: Reference field descriptions table
User->>SDK: Follow link to SDK source for details
SDK-->>User: Access full type definitions
|
- Add missing fields: id, network, type, hash - Remove non-existent logoURI field - Add field descriptions table - Link to SDK source for supported networks and types Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
320c1c4 to
8c72e96
Compare
Problem
The token list documentation has incomplete/incorrect token structure:
network,type,hashlogoURIidfield in JSON exampleCloses RequestNetwork/request-token-list#7
Proposed Solution
networkandtypevalues🤖 Generated with Claude Code