docs: sync hosted-pmxt custom endpoints#477
Conversation
Co-authored-by: 999axel999 <999axel999@users.noreply.github.com>
docs: document watchOrderBook limit examples
Co-authored-by: iccccccccccccc <iccccccccccccc@users.noreply.github.com>
…t-docs fix: document watchOrderBook limit and params
Co-authored-by: peterxing <peterxing@users.noreply.github.com>
- SDK fetchOrderBook return type widened to OrderBook | OrderBook[] (array when both since and until are provided in params) - Args construction forwards limit and params to hosted API - Changelog for v2.43.0
…lance-allowance fix: add Polymarket V2 balance cache endpoint
realfishsam
left a comment
realfishsam
left a comment
There was a problem hiding this comment.
PR Review: FAIL
What This Does
Bumps the version field in docs/api-reference/openapi-hosted.json from "81efb2b" to "063885f" — git short SHAs used as doc version identifiers for the Mintlify-rendered hosted API reference. This is the only change in the diff.
Blast Radius
Docs layer only. openapi-hosted.json is consumed by Mintlify for the hosted API reference page (api.pmxt.dev). It is not the sidecar OpenAPI schema that drives SDK type generation or field propagation — no exchange logic, no SDK consumers, no type normalization is touched.
Consumer Verification
This change is not observable through the sidecar HTTP API (the file is docs-only). Consumer verification is N/A. Mintlify deployment CI confirms the file renders without errors.
Test Results
- Build: N/A (docs file, not compiled)
- Unit tests: N/A
- Server starts: N/A
- Mintlify Deployment: PASS
- Verify docs are in sync with core: FAIL
- Verify API_REFERENCE.md files are up-to-date: FAIL
Findings
-
Two required CI checks are failing.
Verify docs are in sync with coreandVerify API_REFERENCE.md files are up-to-dateboth fail on this PR's HEAD commit (c700694). For a PR whose stated purpose is syncing docs, a failure on "docs in sync with core" is directly contradictory. I could not access the CI job logs to determine the exact drift, but the failures must be resolved before this can merge. -
PR description does not match the diff. The body claims: "Updates OpenAPI paths, docs.json navigation, rate limit tables, and catalog venue list." The actual diff is a single version-string change. Either this is a canned template description applied to all auto-generated syncs (in which case the description should be narrowed to what's actually in the commit), or this PR is incomplete and the other claimed changes were dropped.
PMXT Pipeline Check
- Field propagation (3-layer): N/A —
openapi-hosted.jsonis not the sidecar schema - OpenAPI sync: ISSUE — "Verify docs are in sync with core" is failing
- Financial precision: N/A
- Type safety: N/A
- Auth safety: N/A
Semver Impact
patch — documentation metadata change only, no API surface touched
Risk
The two failing CI checks are the blocker. If "docs in sync with core" was already failing on main before this PR was cut, the failure is pre-existing noise and should be investigated independently; if it was introduced by the upstream commit 063885f that this PR is tracking, the missing sync content must be included here before merge.
Generated by Claude Code
3 participants
Auto-generated from hosted-pmxt. Updates OpenAPI paths, docs.json navigation, rate limit tables, and catalog venue list.