Skip to content

docs: sync hosted-pmxt custom endpoints#641

Merged
realfishsam merged 1 commit into
mainfrom
sync/hosted-docs
Jun 1, 2026
Merged

docs: sync hosted-pmxt custom endpoints#641
realfishsam merged 1 commit 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.

Copy link
Copy Markdown
Contributor Author

@realfishsam realfishsam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Review: PASS (NOT VERIFIED)

What This Does

Bumps the version field in docs/api-reference/openapi-hosted.json from "04d3400" to "bfa6308" — both are git short SHAs from the hosted-pmxt service, used to stamp which deploy of hosted-pmxt generated this spec. No endpoint definitions, schemas, or parameters changed.

Blast Radius

Docs only. openapi-hosted.json is the Mintlify-served API reference for the hosted router (api.pmxt.dev). It is not read by the sidecar server, not imported by any SDK, and explicitly excluded from the docs-sync CI guard (':!docs/api-reference/openapi-hosted.json' in docs-sync-check.yml). No exchange logic, unified types, auth, or SDK consumers are touched.

Consumer Verification

Before (base branch):
docs/api-reference/openapi-hosted.json"version": "04d3400"

After (PR branch):
docs/api-reference/openapi-hosted.json"version": "bfa6308"

No behavioral difference observable through the sidecar HTTP API. Consumer verification skipped — this change is not observable through POST /api/{exchange}/{method}.

Test Results

  • Build: PASS (npm run build --workspace=pmxt-core succeeds)
  • Unit tests: N/A (no logic changed)
  • Server starts: N/A
  • E2E smoke: N/A

Findings

  1. PR description does not match the diff. The body says "Updates OpenAPI paths, docs.json navigation, rate limit tables, and catalog venue list," but the actual diff is a single version-string change. The auto-sync workflow likely generates a generic description regardless of what changed. If hosted-pmxt was supposed to sync new endpoints or navigation in this run and didn't, that should be investigated upstream.

  2. CI failures are pre-existing, not caused by this PR.

    • "Verify docs are in sync with core" — triggered because this PR touches docs/**, but fails because docs/api-reference/openapi.json and docs/llms*.txt in the repo were generated against a different core state than what the local generate scripts produce today. Verified locally: running npm run generate:openapi && npm run generate:mintlify && npm run docs:llms on this branch produces a ~175 KB diff in openapi.json (version field 2.48.12.17.1, plus structural changes to ExchangeParam and code samples). openapi-hosted.json is explicitly excluded from the check and is not the cause. The drift predates this PR.

    • "Verify API_REFERENCE.md files are up-to-date" — runs on all PRs unconditionally. Running npm run generate:docs --workspace=pmxt-core on this branch produces diffs in sdks/python/API_REFERENCE.md and sdks/typescript/API_REFERENCE.md showing fetchSeries, UnifiedSeries, sourceMetadata, and the series event-filter param are missing from the committed reference. These were introduced in commit bdc4cfa ("feat: add UnifiedSeries type and fetchSeries") but the reference docs were not regenerated. This failure exists on main and will affect every PR until fixed.

    Neither failure is a regression introduced by this PR.

PMXT Pipeline Check

  • Field propagation (3-layer): N/A — no type changes
  • OpenAPI sync: N/A — openapi.yaml (sidecar contract) not touched
  • Financial precision: N/A
  • Type safety: N/A
  • Auth safety: N/A

Semver Impact

patch — documentation-only change to a hosted-API spec file; no SDK or sidecar API contract modified.

Risk

The pre-existing CI failures (docs drift + stale API_REFERENCE.md) should be resolved on main before they accumulate further. The API_REFERENCE.md gap means fetchSeries, UnifiedSeries, and sourceMetadata are silently missing from the published SDK reference docs today — that's a discoverability issue for SDK consumers, independent of this PR.


Generated by Claude Code

@realfishsam realfishsam merged commit 340cfb3 into main Jun 1, 2026
10 of 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