Skip to content

docs: refresh based on pymthouse/pymthouse v0.2.4 changes#3

Draft
eliteprox wants to merge 1 commit into
mainfrom
cursor/refresh-docs-6ef8
Draft

docs: refresh based on pymthouse/pymthouse v0.2.4 changes#3
eliteprox wants to merge 1 commit into
mainfrom
cursor/refresh-docs-6ef8

Conversation

@eliteprox

Copy link
Copy Markdown
Collaborator

Summary

Refreshes the Mintlify docs to reflect the latest changes landed in pymthouse/pymthouse, covering commits up to v0.2.4 (Jun 26 2026).


Changes

api-reference/introduction.mdx

  • Documents the new self-hosted OpenAPI endpoints added in PR #166:
    • GET /api/v1/openapi.json — machine-readable OpenAPI 3.1 document
    • GET /api/v1/docs — interactive Scalar API reference UI
  • Adds a note on regenerating the route inventory (npm run openapi:generate) and the CI drift check (npm run check:openapi).

integration/api-keys.mdx

  • Adds the canonical single-call signer session endpoint (POST .../auth/api-key/signer-session) with the full SignerSession envelope response (PR #166).
  • Adds a <Warning> explaining the pmth_cs_* credential type restriction — presenting an M2M secret to API-key exchange routes returns 400 invalid_request (not 401).
  • Fixes the GET /api/v1/auth/validate reference to the new POST form with a JSON body.
  • Removes the deprecated app-level keys section (/apps/{clientId}/keys) and the facadeUrl-based exchangeApiKeyForSignerSession example.

integration/deprecated.mdx

  • Adds three new removal entries (PR #166):
    • GET /api/v1/auth/validatePOST with { "key": "pmth_…" } body
    • GET/POST/DELETE /api/v1/apps/{clientId}/keys → per-user keys at .../users/{externalUserId}/keys
    • Dashboard BFF POST /api/pymthouse/keys/exchangePOST .../auth/api-key/signer-session directly on the issuer
  • Updates the summary table to include all three new removals.

integration/user-tokens.mdx

  • Adds the external_user_id JWT claim to the claims table (PR #168 — Builder user JWTs now carry the externalUserId for downstream attribution without a separate lookup).
  • Updates the <Warning> to recommend external_user_id over parsing sub.

integration/billing.mdx

  • Documents the Stripe billing graceful fallback behaviour (PR #170): apps without a fully connected Stripe account still provision users onto the Free Starter plan rather than failing. Starter subscription provisioning now handles Stripe "not ready" errors without surfacing them to end-users.

integration/token-exchange.mdx

  • Expands the signer session exchange response to show the full SignerSession envelope fields (balanceUsdMicros, lifetimeGrantedUsdMicros, signer_url, issued_token_type, correlation_id) with a field-by-field table (PR #166).
  • Adds a <Note> pointing to the API-key single-call path for integrations that don't need a prior user JWT.

Source PRs referenced

PR Title
#166 feat(api): OpenAPI self-documentation and signer-session convergence
#168 fix(oidc): include external_user_id on programmatic user JWTs
#170 feat(billing): integrate Stripe billing checks into OpenMeter
#172 chore(release): bump version to 0.2.4
Open in Web Open in Cursor 

- api-reference/introduction.mdx: document new OpenAPI endpoints
  GET /api/v1/openapi.json and GET /api/v1/docs (Scalar UI)

- integration/api-keys.mdx: add canonical signer-session endpoint
  POST .../auth/api-key/signer-session with SignerSession envelope;
  fix GET /api/v1/auth/validate → POST; add pmth_cs_* type warning;
  remove deprecated app-level keys section

- integration/deprecated.mdx: add three new removal entries
  - GET /api/v1/auth/validate → POST with JSON body
  - GET/POST/DELETE /api/v1/apps/{clientId}/keys → per-user keys
  - POST /api/pymthouse/keys/exchange BFF → auth/api-key/signer-session
  Update summary table with all new removals

- integration/user-tokens.mdx: add external_user_id JWT claim
  (included on programmatic user JWTs per PR #168)

- integration/billing.mdx: document Stripe billing graceful fallback
  Apps without Stripe billing connected still get Free Starter access
  (per PR #170)

- integration/token-exchange.mdx: document full SignerSession envelope
  fields returned from signer session exchange (balanceUsdMicros,
  lifetimeGrantedUsdMicros, signer_url, issued_token_type, correlation_id)

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

coderabbitai Bot commented Jun 26, 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: 01fb3d2c-87ac-4cfa-a89f-75eeef138cf0

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/refresh-docs-6ef8

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