Skip to content

docs: sync hosted-pmxt custom endpoints#998

Open
realfishsam wants to merge 1 commit into
mainfrom
sync/hosted-docs
Open

docs: sync hosted-pmxt custom endpoints#998
realfishsam wants to merge 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.

@realfishsam

Copy link
Copy Markdown
Contributor Author

PR Review: PASS (NOT VERIFIED)

What This Does

This re-splits the hosted API reference so cross-venue router/catalog endpoints remain in openapi-hosted.json, while hosted trading/account endpoints are referenced from openapi-hosted-trading.json. For docs consumers, the API Reference navigation now points trading and order/account pages at the trading-specific OpenAPI file.

Blast Radius

Documentation only: docs/api-reference/openapi-hosted.json, docs/docs.json, and docs/llms-full.txt. No SDK, sidecar runtime, exchange normalizer, or generated SDK client code changes.

Consumer Verification

Before (base branch):
docs/api-reference/openapi-hosted.json bundled router/catalog paths and hosted trading/account components together, including hosted trading schemas such as BuildOrderHostedRequest, SubmitOrderHostedRequest, and HostedErrorResponse.

After (PR branch):
JSON validation and path inspection on PR head 627c8001 succeeded:

openapi-hosted.json paths: /v0/matched-event-clusters, /v0/matched-market-clusters, /v0/sql
openapi-hosted-trading.json paths: /v0/trade/create-order, /v0/trade/build-order, /v0/trade/submit-order,
  /v0/orders/cancel/build, /v0/orders/open, /v0/orders/{order_id},
  /v0/user/{address}/trades, /v0/user/{address}/positions, /v0/user/{address}/balances

docs/docs.json now maps the Cross Exchange and Enterprise groups to api-reference/openapi-hosted.json, and the Trading / Orders & Positions groups to api-reference/openapi-hosted-trading.json.

Test Results

  • Build: Not run; docs-only OpenAPI/navigation sync.
  • Unit tests: N/A
  • Server starts: N/A
  • E2E smoke: PASS for local JSON parse/path/navigation inspection of the touched docs files.

Findings

No blocking findings.

PMXT Pipeline Check

  • Field propagation (3-layer): N/A
  • OpenAPI sync: OK for the docs split inspected here.
  • Financial precision: N/A
  • Type safety: N/A
  • Auth safety: N/A

Semver Impact

patch -- documentation/spec navigation sync only.

Risk

I did not render the Mintlify site locally, so final hosted-doc page generation remains dependent on Mintlify accepting endpoint references from the separate openapi-hosted-trading.json file. The checked JSON and navigation wiring are internally consistent.

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