Skip to content

docs: sync hosted-pmxt custom endpoints#842

Merged
realfishsam merged 4 commits into
mainfrom
sync/hosted-docs
Jun 8, 2026
Merged

docs: sync hosted-pmxt custom endpoints#842
realfishsam merged 4 commits into
mainfrom
sync/hosted-docs

Conversation

@realfishsam

Copy link
Copy Markdown
Contributor

Auto-generated from hosted-pmxt. Updates OpenAPI paths, docs.json navigation, rate limit tables, and catalog venue list.

@realfishsam

Copy link
Copy Markdown
Contributor Author

PR Review: FAIL

What This Does

Updates docs/OpenAPI documentation around hosted/custom endpoints and historical fetch-order-book usage. Runtime SDK behavior should be unchanged.

Blast Radius

Documentation/OpenAPI docs artifacts only.
Changed files reviewed: docs/api-reference/openapi-hosted.json

Consumer Verification

Before (base branch):
Base branch (origin/main) does not include these changes. I reviewed the diff against the base and did not run full live-exchange before/after reproduction in this daily batch.

After (PR branch):
PR branch build FAIL; authenticated local sidecar smoke FAIL using POST /api/mock/fetchMarkets with x-pmxt-access-token, response snippet: skipped because build failed

Test Results

  • Build: FAIL (npm run build --workspace=pmxt-core)
  • Unit tests: FAIL (npm test --workspace=pmxt-core -- --runInBand)
  • Server starts: FAIL
  • E2E smoke: FAIL (POST /api/mock/fetchMarkets; live venue-specific calls were not made)
  • Dependency install: skipped (existing workspace deps reused)

Findings

  1. Build failed: src/exchanges/limitless/websocket.ts(276,39): error TS2345: Argument of type '"orderbook"' is not assignable to parameter of type 'SubscriptionChannel'.
    src/exchanges/limitless/websocket.ts(279,39): error TS2345: Argument of type '"prices"' is not assignable to parameter of type 'SubscriptionChannel'.
    ../node_modules/ox/tempo/KeyAuthorization.ts(537,3): error TS2322: Type '{ account?: 0x${string} | undefined; isAdmin?: true | undefined; witness?: 0x${string} | undefined; signature: SignatureEnvelope.SignatureEnvelope<bigint, number>; ... 5 more ...; chainId: bigint; }' is not assignable to type 'Signed<bigint, number, 0x${string}>'.
    Type '{ account?: 0x${string} | undefined; isA...
  2. Core Jest tests failed: at Object. (test/normalizers/exchange-normalizers-3.test.ts:19:1)

Test Suites: 7 failed, 1 skipped, 15 passed, 22 of 23 total
Tests: 3 skipped, 451 passed, 454 total
Snapshots: 0 total
Time: 11.434 s
Ran all test suites.
npm ERR! Lifecycle script test failed with error:
npm ERR! Error: command failed
npm ERR! in workspace: pmxt-core@2.17.1
npm ERR! at location: /opt/data/repos/pmxt/core
3. Server/API smoke failed: skipped because build failed

PMXT Pipeline Check

  • Field propagation (3-layer): N/A
  • OpenAPI sync: N/A
  • Financial precision: N/A
  • Type safety: OK
  • Auth safety: N/A

Semver Impact

patch -- docs/metadata-only change

Risk

The 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.

@realfishsam realfishsam merged commit 184686e into main Jun 8, 2026
12 checks passed
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