Update documentation to match current SDK state#1919
Merged
Conversation
Fix inaccuracies and add missing documentation for recently added features: - Fix getOrder by hash example to use correct getOrderByHash method - Fix getCollectionOffers return type and add missing pagination params - Add Token API endpoints (getTrendingTokens, getTopTokens, getSwapQuote, getToken) - Add Search API endpoint documentation - Add multi-trait and numeric trait offer params to buildOffer/postCollectionOffer - Add includePrivateListings param to listing endpoints - Add missing generateFulfillmentData params - Fix FAQ GitHub line reference for GET/POST methods Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Line number references break whenever the file changes. Link to the file and reference method/type names instead. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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
getTrendingTokens,getTopTokens,getSwapQuote,getToken) and Search API (search) endpointsincludePrivateListings,traits/numericTraits,generateFulfillmentDataparams)Details
Fixes:
getting-started.md: "Fetching an Order by Hash" example incorrectly usedgetOrder()with non-existent params — fixed to usegetOrderByHash()api-reference.md:getCollectionOffersreturn type wasListCollectionOffersResponse | nullbut actual return isGetOffersResponse; also added missinglimit/nextparamsfaq.md: GitHub links pointed to specific line numbers that were outdated — replaced with stable file-level links referencing method/type namesNew documentation:
getTrendingTokens,getTopTokens,getSwapQuote,getTokensearchacross collections, tokens, NFTs, and accountstraitsarray) and numeric trait offers (numericTraits) forbuildOffer,postCollectionOffer, andcreateCollectionOfferincludePrivateListingsparam ongetAllListings,getBestListing,getBestListings,getNFTListingsunitsToFill,recipientAddress,includeOptionalCreatorFeesparams ongenerateFulfillmentDataTest plan
🤖 Generated with Claude Code