Skip to main content

Documentation accuracy review

2026-09-18 review

Compared the public API handlers, shared request and response models, changes since the September 9 review, deployed OpenAPI exports, and streaming models at the rust_types revision pinned by Cargo.lock (9829d4c). Local protobuf definitions were also checked. This is a documentation and contract review, not a live authenticated trading test. Market and strategy APIs are intentionally excluded at the owner’s direction. They are private, under development, and access or feature gated. They have no public navigation or exports. The exporter also omits the private strategy entitlement from billing schemas.

Corrections

The existing seven deployed exports match their checked-in contracts after publication filtering. The instrument export adds three operations, bringing validation to eight specs and 91 method/path pairs, including hidden operations. No new broker support is inferred from catalog schemas.

Publication gaps and follow-up

  • Notifications has two authenticated read handlers in source, but https://api.anthid.com/v1/notifications/openapi.json returned HTTP 404 during the audit. It remains outside public documentation pending confirmation of deployment and intended publication.
  • The MCP default API_SPECS list has six services. After the docs publish, its configuration must include billing and instruments to index those references. No runtime configuration was changed here.
  • The exporter still reports the existing retired-broker name in BrokerCredentialVariant.description. It explicitly describes an unsupported variant; retired credential variants remain structurally removed.

Verification

Run from anthid/ unless noted:
  • node apps/docs/api-reference/scripts/generate-openapi.mjs --check: passed against all eight deployed public exports after publication filtering, without file changes.
  • node apps/docs/api-reference/scripts/generate-openapi.mjs --local --check: passed; local publication processing is stable.
  • node apps/docs/api-reference/scripts/validate-reference.mjs: passed for eight specs, 91 source endpoints, schema and security references, and navigation coverage.
  • node --test apps/docs/api-reference/scripts/reference.test.mjs: seven tests passed, including missing navigation, missing source coverage, hidden operations, broken references, private exports, no-write checks, and failed-refresh preservation. The sandbox initially denied child Node processes; rerunning with the approved execution permission passed.
  • mint validate --telemetry false, from apps/docs/: passed. The sandbox initially blocked Mintlify’s network-interface check; rerunning with the approved execution permission passed.
  • mint broken-links --telemetry false, from apps/docs/: passed with no broken links.
  • mint dev --port 3034 --telemetry false, from apps/docs/: previewed the Instruments overview and generated list endpoint in the browser; confirmed navigation, rendered content, and examples. Stopped the preview afterward.
  • git diff --check: passed.
Only apps/docs and its export/validation tooling changed. No Rust package or service binary, database schema, or stream contract changed. No authenticated broker calls, deployment, migrations, secrets, or production configuration changes were made. Publish the documentation through its normal release process; runtime contract deployment was not verified by this review.

Previous review: 2026-09-09

Reviewed on 2026-09-09 against the monorepo implementations, the local shared protobuf definitions, and public REST OpenAPI exports.

Changes and evidence

The broker pages’ Alpaca position limitation and current order-type coverage remain consistent with the adapter and intent request model. No new broker support is inferred from shared enum or schema names.

Verification

Run from anthid/ unless a different directory is noted:
  • node apps/docs/api-reference/scripts/generate-openapi.mjs: fetched all seven public REST specifications. The exporter reports one upstream description mentioning the retired IBKR integration. The description explicitly says it is not a credential variant; no IBKR credential variant is exposed.
  • node apps/docs/api-reference/scripts/generate-openapi.mjs --local: processing completed, including hiding the operator-only billing override route.
  • node apps/docs/api-reference/scripts/validate-reference.mjs: passed for seven specs and 88 method/path pairs, local schema references, and navigation.
  • mint validate --telemetry false, from apps/docs/: passed.
  • mint broken-links --telemetry false, from apps/docs/: passed with no broken links.
  • cargo check --offline --manifest-path /tmp/anthid-docs-rust-check/Cargo.toml: passed for the Rust server-streaming example and its event match, extracted into a temporary crate and generated against the local protobuf definitions. This did not connect to a broker or streaming service.
  • git diff --check: passed.
Method/path parity does not prove deployed business behavior or schema equivalence with every Rust type. Streaming behavior was checked against source, not a live authenticated session. No broker orders, migrations, deployment, or credential/configuration changes were made. Only the docs app and its export/validation tooling are affected; no service binaries, database schemas, or stream contracts changed.