docs: clarify historical fetch order book usage#837
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
PR Review: FAILWhat This DoesUpdates docs/OpenAPI documentation around hosted/custom endpoints and historical fetch-order-book usage. Runtime SDK behavior should be unchanged. Blast RadiusDocumentation/OpenAPI docs artifacts only. Consumer VerificationBefore (base branch): After (PR branch): Test Results
Findings
Test Suites: 7 failed, 15 passed, 22 total PMXT Pipeline Check
Semver Impactpatch -- docs/metadata-only change RiskThe branch was built, core-tested, and authenticated-smoke-tested through the sidecar. Full live-exchange before/after behavior remains unverified for this daily batch; credentialed venue calls and venue API drift should be treated as residual risk unless covered by tests in this PR. |
Summary
fetch_order_book(token_id)without historical params uses the live CLOB only and can fail for closed/resolved markets.fetch_event(slug=...)with nested markets for crypto 5m event slugs.Closes #836
Test plan
package.jsondocs scripts; no dedicated docs/MDX validation script was present.git diff --check.