Skip to content

Document durable resource lifecycle contracts - #488

Merged
IlyaasK merged 2 commits into
mainfrom
hypeship/durable-resource-lifecycle-docs
Aug 7, 2026
Merged

Document durable resource lifecycle contracts#488
IlyaasK merged 2 commits into
mainfrom
hypeship/durable-resource-lifecycle-docs

Conversation

@IlyaasK

@IlyaasK IlyaasK commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Summary

  • document profile rename behavior and active-session risk
  • document proxy rename identity and ambiguity behavior
  • define extension checksum byte semantics and legacy nullability
  • document API-key self-deletion rejection

Why

These durable lifecycle contracts are merged and released but were not described precisely enough for operators using the API and SDKs.

Verification

  • Mint broken-links
  • git diff --check
  • claims checked against kernel/kernel merged origin/main
  • SDK response fields checked against Node, Python, and Go SDK v0.86.1

Note

Low Risk
Docs-only changes with no runtime, auth, or data-path modifications.

Overview
Documentation-only update that spells out operator-facing lifecycle behavior for profiles, proxies, extensions, and API keys—aligned with already-shipped API/SDK behavior.

Adds Rename a profile (profiles.update) with project-unique names and a warning about renaming while a session still references the old name and save_changes may fail to persist. Adds Rename a proxy (proxies.update by ID) and notes that proxy names are not unique, so updates must use ID when names collide.

Extensions metadata now documents optional lowercase hex SHA-256 checksum over uploaded archive bytes (not unpacked/normalized content), and when checksum may be null (legacy / repackaged Web Store extensions). API keys get a warning that a key cannot delete itself—use a different credential for delete requests.

Reviewed by Cursor Bugbot for commit e5157a6. Bugbot is set up for automated code reviews on this repo. Configure here.

Explain profile and proxy renames, extension archive checksums, and the API-key self-delete guard so public conceptual docs match the generated API and current SDKs.
@mintlify

mintlify Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
Kernel 🟢 Ready View Preview Aug 6, 2026, 10:06 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@vercel

vercel Bot commented Aug 6, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Error Error Aug 7, 2026 3:19pm

cursor[bot]
cursor Bot approved these changes Aug 6, 2026
@IlyaasK
IlyaasK requested review from AnnaXWang and Sayan- August 7, 2026 14:52

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk assessment: Very Low

Verdict: Keep existing approval (risk unchanged)

Re-evaluation after synchronize

This automation previously approved commit e5157a6. Head is now 52dee86 ("Remove incorrect profile rename warning"). Re-assessed from the current full diff vs main.

Evidence (from diff only)

  • 4 files changed (+46 / −1), all Mintlify .mdx documentation pages:
    • auth/profiles.mdx — documents profile rename via profiles.update and project-unique names (delta since last approval: removes a <Warning> block only)
    • proxies/overview.mdx — documents proxy rename via ID and non-unique names
    • browsers/extensions.mdx — documents optional SHA-256 checksum semantics and nullability
    • info/api-keys.mdx — documents that an API key cannot delete itself
  • No application code, config, CI, infrastructure, schema, or auth/permission implementation changes
  • Diff is documentation prose plus SDK usage examples (TypeScript / Python / Go)
  • No CODEOWNERS file found

Why Very Low

Still a small, documentation-only surface with no production logic, shared systems, or infra impact. The follow-up commit only deletes incorrect warning prose; blast radius did not increase.

Action taken

  • Risk remains Very Low → approval retained
  • Did not re-approve (already approved by this automation)
  • Did not dismiss approval (risk did not increase)
Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@IlyaasK
IlyaasK merged commit 52c176b into main Aug 7, 2026
6 of 7 checks passed
@IlyaasK
IlyaasK deleted the hypeship/durable-resource-lifecycle-docs branch August 7, 2026 17:53
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