Skip to content

docs: sync Mintlify guides with pymthouse 0.3.2 Builder API#4

Draft
eliteprox wants to merge 1 commit into
mainfrom
cursor/sync-docs-pymthouse-0-3-2-349f
Draft

docs: sync Mintlify guides with pymthouse 0.3.2 Builder API#4
eliteprox wants to merge 1 commit into
mainfrom
cursor/sync-docs-pymthouse-0-3-2-349f

Conversation

@eliteprox

Copy link
Copy Markdown
Collaborator

Summary

Updates integrator docs to match the latest pymthouse Builder API contract (docs/builder-api.md, app version 0.3.2).

Prior Mintlify pages still documented pre-cleanup surfaces (pmth_ak_*, POST .../auth/api-key/*, app-level /keys, GET /auth/validate) that 0.3.x removed.

Key changes

  • Credentials: document pmth_<hex>, presented app_<clientId>.pmth_<hex>, and pmth_cs_* (drop nonexistent pmth_ak_*)
  • SignerSession exchange: canonical path is POST /api/v1/apps/{clientId}/oidc/token (RFC 8693); Basic optional when subject_token is an API key
  • Removals / migrations: full breaking-changes table including auth/api-key/*, app-level keys, GET validate, BFF keys/exchange
  • OpenAPI: document GET /api/v1/openapi.json and Scalar GET /api/v1/docs
  • Related: external_user_id JWT claim, Stripe-not-required-for-Starter note, README org link → pymthouse/pymthouse

Files touched

integration/api-keys, client-model, token-exchange, user-management, sdk, signer-routing, deprecated, user-tokens, billing, manifest, plus api-reference/introduction, index, README

Verification

  • npm run validate — build validation passed
Open in Web Open in Cursor 

Align integrator docs with the latest pymthouse contract:
- Credential prefixes: pmth_<hex>, app_*.pmth_*, pmth_cs_* (drop pmth_ak_*)
- SignerSession exchange via POST .../apps/{clientId}/oidc/token
- Remove auth/api-key/*, app-level /keys, and GET /auth/validate
- Document OpenAPI/Scalar (openapi.json + /docs)
- Update deprecations, README org link, and related guides

Co-authored-by: John | Elite Encoder <john@eliteencoder.net>
@coderabbitai

coderabbitai Bot commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: ab5ab1fc-c59b-4846-a857-6ab856c7cbbb

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch cursor/sync-docs-pymthouse-0-3-2-349f

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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.

2 participants