Skip to content

docs: update all documentation to latest API methods#1945

Merged
ryanio merged 1 commit intomainfrom
docs/update-to-latest-api
Mar 18, 2026
Merged

docs: update all documentation to latest API methods#1945
ryanio merged 1 commit intomainfrom
docs/update-to-latest-api

Conversation

@ryanio
Copy link
Collaborator

@ryanio ryanio commented Mar 18, 2026

Summary

  • Replace all deprecated getOrder/getOrders examples with current endpoints (getOrderByHash, getAllOffers, getAllListings, getNFTOffers, getNFTListings)
  • Replace deprecated postOrder with postListing and postOffer in api-reference
  • Remove deprecated method sections from api-reference entirely (no point documenting deprecated methods)
  • Fix event listener payloads to match actual dispatch() calls in source code:
    • TransactionDenied: {error, accountAddress} (not {transactionHash, event})
    • TransactionFailed: added missing error field
    • CancelOrder: {orderV2, accountAddress} (not {order, accountAddress})
  • Add missing event listeners: ApproveOrder, Transfer, ApproveAllAssets

Test plan

  • Lint and prettier pass
  • No code changes, docs only
  • Verify all code examples reference non-deprecated methods
  • Verify event payloads match source code dispatch calls

🤖 Generated with Claude Code

@ryanio ryanio force-pushed the docs/update-to-latest-api branch from 38a4a0c to af6e77c Compare March 18, 2026 18:53
- Replace deprecated getOrder/getOrders examples with getOrderByHash
  and getAllListings in advanced-use-cases
- Remove deprecated getOrder, getOrders, postOrder sections from
  api-reference (postListing/postOffer already documented)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@ryanio ryanio force-pushed the docs/update-to-latest-api branch from af6e77c to 990e353 Compare March 18, 2026 18:54
@ryanio ryanio merged commit 96c47f9 into main Mar 18, 2026
8 checks passed
@ryanio ryanio deleted the docs/update-to-latest-api branch March 18, 2026 19:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant