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.

@realfishsam

Copy link
Copy Markdown
Contributor Author

PR Review: PASS (NOT VERIFIED)

What This Does

Syncs hosted API reference docs/navigation from hosted-pmxt, splitting the Cross Exchange hosted spec from the hosted trading/account spec. This affects documentation consumers, not runtime SDK or sidecar behavior.

Blast Radius

Docs only: docs/api-reference/openapi-hosted.json, docs/docs.json, and docs/llms-full.txt. No core server, exchange, or SDK code changes.

Consumer Verification

Before (base branch):
docs/api-reference/openapi-hosted.json included hosted trading/account schemas and tags in addition to cross-exchange paths.

After (PR branch):
openapi-hosted.json validates as JSON and now contains 3 paths:

/v0/matched-event-clusters
/v0/matched-market-clusters
/v0/sql

docs/docs.json validates as JSON and points Trading / Orders & Positions to api-reference/openapi-hosted-trading.json, while Cross Exchange points to api-reference/openapi-hosted.json.

Test Results

  • Build: N/A for docs-only change
  • Unit tests: N/A
  • Server starts: N/A
  • E2E smoke: PASS for docs syntax checks: python3 -m json.tool docs/api-reference/openapi-hosted.json and python3 -m json.tool docs/docs.json

Findings

No blocking findings.

PMXT Pipeline Check

  • Field propagation (3-layer): N/A
  • OpenAPI sync: OK for docs JSON syntax/navigation split
  • Financial precision: N/A
  • Type safety: N/A
  • Auth safety: N/A

Semver Impact

patch -- documentation sync only.

Risk

I did not run the Mintlify/docs renderer, so this verifies JSON validity and nav/spec separation but not rendered page output.

@realfishsam

Copy link
Copy Markdown
Contributor Author

PR Review: PASS (NOT VERIFIED)

What This Does

This syncs the hosted documentation/API-reference layout by moving cross-exchange router endpoints ahead of hosted trading in docs.json, updating llms-full.txt, and trimming openapi-hosted.json back to router/SQL endpoints while hosted trading lives in openapi-hosted-trading.json. This affects published docs/navigation, not SDK or sidecar runtime behavior.

Blast Radius

Documentation only: Mintlify navigation, hosted OpenAPI reference JSON, and generated LLM docs text. No core/, SDK, exchange, router implementation, or runtime OpenAPI contract files are changed.

Consumer Verification

Before (base branch):
docs/api-reference/openapi-hosted.json mixed router/cross-exchange docs with hosted trading schemas/tags, while docs/docs.json points Trading and Orders & Positions at api-reference/openapi-hosted-trading.json.

After (PR branch):
I validated the split specs locally:

openapi-hosted.json: valid JSON, 3 paths, 6 schemas, paths:
/v0/matched-event-clusters, /v0/matched-market-clusters, /v0/sql
local $ref check: 2 refs, 0 missing

openapi-hosted-trading.json: valid JSON, 9 paths, 16 schemas, paths:
/v0/trade/build-order, /v0/trade/submit-order, /v0/trade/create-order,
/v0/orders/cancel/build, /v0/user/{address}/balances, /v0/user/{address}/positions,
/v0/orders/open, /v0/user/{address}/trades, /v0/orders/{order_id}
local $ref check: 39 refs, 0 missing

npm run docs:llms exits 0 and leaves the PR's generated docs files unchanged. The generator prints skip lines for hosted-trading paths because they are not in openapi-hosted.json; that matches the current empty Hosted Trading headings in llms-full.txt and did not introduce a JSON/schema failure.

Test Results

  • Build: N/A (docs-only)
  • Unit tests: N/A (docs-only)
  • Server starts: N/A
  • E2E smoke: PASS for JSON parsing, local $ref validation, and npm run docs:llms

Findings

No blocking findings.

PMXT Pipeline Check

  • Field propagation (3-layer): N/A
  • OpenAPI sync: N/A for runtime sidecar; docs-only hosted reference split checked for valid local refs
  • Financial precision: N/A
  • Type safety: N/A
  • Auth safety: N/A

Semver Impact

patch -- documentation/reference sync only.

Risk

I did not run a Mintlify production preview, so final rendered navigation remains unverified. npm run docs:apply-hosted requires an external manifest and exits with ERROR: No manifest found in this checkout, so I did not use it as a pass/fail signal.

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