docs: refresh based on pymthouse/pymthouse v0.2.4 changes#3
Draft
eliteprox wants to merge 1 commit into
Draft
Conversation
- 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>
Contributor
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.mdxGET /api/v1/openapi.json— machine-readable OpenAPI 3.1 documentGET /api/v1/docs— interactive Scalar API reference UInpm run openapi:generate) and the CI drift check (npm run check:openapi).integration/api-keys.mdxPOST .../auth/api-key/signer-session) with the fullSignerSessionenvelope response (PR #166).<Warning>explaining thepmth_cs_*credential type restriction — presenting an M2M secret to API-key exchange routes returns400 invalid_request(not401).GET /api/v1/auth/validatereference to the newPOSTform with a JSON body./apps/{clientId}/keys) and thefacadeUrl-basedexchangeApiKeyForSignerSessionexample.integration/deprecated.mdxGET /api/v1/auth/validate→POSTwith{ "key": "pmth_…" }bodyGET/POST/DELETE /api/v1/apps/{clientId}/keys→ per-user keys at.../users/{externalUserId}/keysPOST /api/pymthouse/keys/exchange→POST .../auth/api-key/signer-sessiondirectly on the issuerintegration/user-tokens.mdxexternal_user_idJWT claim to the claims table (PR #168 — Builder user JWTs now carry theexternalUserIdfor downstream attribution without a separate lookup).<Warning>to recommendexternal_user_idover parsingsub.integration/billing.mdxintegration/token-exchange.mdxSignerSessionenvelope fields (balanceUsdMicros,lifetimeGrantedUsdMicros,signer_url,issued_token_type,correlation_id) with a field-by-field table (PR #166).<Note>pointing to the API-key single-call path for integrations that don't need a prior user JWT.Source PRs referenced