chore: update the api reference spec - #492
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
5aebdcb to
6ffab4a
Compare
There was a problem hiding this comment.
Stale comment
Risk assessment: Very Low
Verdict: Prior approval remains valid (not re-approved)
Re-evaluation after synchronize
This PR was previously approved by this automation on commit
5aebdcbb. Head is now6ffab4a4. Re-assessed from the full diff against the base.What changed
- Single file:
specs/openapi.documented.yml(+7 / −0)- Adds optional boolean
profile_save_changes(with description) to the browser session schema- Documents existing
403 Forbiddenresponses on audit log list and export chunk operationsWhy Very Low
- Documentation/API-reference OpenAPI spec only; no application, runtime, or infrastructure code
- Additive schema/response documentation; no auth, billing, permissions, or production logic changes in this repo
- Small, easy to reason about; blast radius limited to published API reference docs
- Risk did not increase vs. the prior assessment → approval not dismissed
- No CODEOWNERS file/requirement detected
Action
- Not re-approving (an approval from this automation already exists)
- Not dismissing approval (risk remained Very Low)
Sent by Cursor Automation: Assign PR reviewers
6ffab4a to
c7fc0a5
Compare
There was a problem hiding this comment.
Stale comment
Risk assessment: Very Low
Verdict: Prior approval remains valid (not re-approved)
Re-evaluation after synchronize
This PR was previously approved by this automation on commit
5aebdcbb. Head is nowc7fc0a54. Re-assessed from the full diff against the base (512e314...c7fc0a54).What changed (from the diff)
- Single file:
specs/openapi.documented.yml(+312 / −10)- Adds optional boolean
profile_save_changesto the browser session schema- Updates managed-auth submit-fields description (SSE → poll)
- Removes
x-stainless-skipon audit log export destination operations; keepsx-hidden/x-cli-skip- Adds Enterprise-plan notes, operation descriptions, and JS/Python/Go
x-codeSamplesfor those endpoints- Documents
403 Forbiddenon audit log list and export-chunk operationsWhy Very Low
- Documentation/API-reference OpenAPI spec only in this Mintlify docs repo; no application, runtime, or infrastructure code
- Additive schema/response docs and example snippets; no auth, billing, permissions, or production logic changes here
- Blast radius limited to published API reference content after redeploy
- Risk did not increase above Very Low vs. the prior assessment → approval not dismissed
- No CODEOWNERS file/requirement detected
Action
- Not re-approving (an approval from this automation already exists)
- Not dismissing approval (risk remained Very Low)
Sent by Cursor Automation: Assign PR reviewers
c7fc0a5 to
ad08376
Compare
There was a problem hiding this comment.
Risk assessment: Very Low
Verdict: Prior approval remains valid (not re-approved)
Re-evaluation after synchronize
This PR was previously approved by this automation on commit 5aebdcbb. Head is now ad083763. Re-assessed from the full diff against the base (3ad0d55...ad083763).
What changed (from the diff)
- Single file:
specs/openapi.documented.yml(+470 / −10) - Adds
AuthContext*schemas and documentsGET /auth/context(with JS/Python/Gox-codeSamples) - Adds optional boolean
profile_save_changeson the browser session schema - Updates managed-auth submit-fields description (SSE → poll)
- Removes
x-stainless-skipon audit log export destination operations; keepsx-hidden/x-cli-skip - Adds Enterprise-plan notes, operation descriptions, and code samples for those endpoints
- Documents
403 Forbiddenon audit log list and export-chunk operations
Why Very Low
- Documentation/API-reference OpenAPI spec only in this Mintlify docs repo; no application, runtime, or infrastructure code
- Additive schema/response docs and example snippets; no auth, billing, permissions, or production logic changes here
- Blast radius limited to published API reference content after redeploy
- Risk did not increase above Very Low vs. the prior assessment → approval not dismissed
- No CODEOWNERS file/requirement detected
Action
- Not re-approving (an approval from this automation already exists)
- Not dismissing approval (risk remained Very Low)
Sent by Cursor Automation: Assign PR reviewers


Opened by the stlc generate workflow in kernel/kernel (
8a7c2e54c191e8fca2a3fcd33768fa6876d7d36c). Merging redeploys the API reference from the updated spec.Note
Low Risk
Documentation and OpenAPI-only changes; no application code in this diff, though SDK generation may expose previously skipped audit export APIs.
Overview
Updates
specs/openapi.documented.ymlfor the published API reference.Authentication: Adds
GET /auth/contextunder a new Authentication tag, withAuthContextschemas (authentication method/source, principal, organization, credential vs effective scope). Includes JS/Python/Gox-codeSamples.Browsers: Documents
profile_save_changeson browser session responses (whether session changes persist to the attached profile).Managed auth:
POST /auth/connections/{id}/submitdescription now says to poll the auth connection instead of following an SSE stream.Audit logs: Audit log export destination routes lose
x-stainless-skip(so they can appear in generated SDKs), gain clearer descriptions (including Enterprise plan requirements), and get SDK code samples. List/export-style audit log operations document an additional403 Forbiddenresponse.Reviewed by Cursor Bugbot for commit ad08376. Bugbot is set up for automated code reviews on this repo. Configure here.