Skip to content
This repository was archived by the owner on Sep 21, 2026. It is now read-only.

docs: stop documenting key and JWT minting from existing credentials - #3178

Merged
atharvadeosthale merged 4 commits into
mainfrom
docs/remove-key-jwt-create-methods
Aug 17, 2026
Merged

atharvadeosthale merged 4 commits into
mainfrom
docs/remove-key-jwt-create-methods

Conversation

@atharvadeosthale

Copy link
Copy Markdown
Member

Summary

  • Remove project.createKey and client account.createJWT from docs, matching Cloud blocking those methods so leaked credentials cannot mint replacements.
  • Point JWT creation at users.createJWT, keep Console + ephemeral key flows, and add info notes on the API keys, key rotation, and JWT pages.
  • Add a 2026-08-17 changelog entry for the change.

Test plan

  • Confirm /docs/partners/project/api-keys has no create-key SDK examples and shows the Creating keys info note
  • Confirm /docs/partners/project/key-rotation sends long-lived key creation to the Console and still documents list/update/delete/ephemeral
  • Confirm /docs/products/auth/jwt uses users.createJWT and links the changelog
  • Confirm /changelog/entry/2026-08-17 renders

Cloud no longer allows project.createKey or account.createJWT, so leaked credentials cannot mint replacements.
@appwrite

appwrite Bot commented Aug 17, 2026 •

Copy link
Copy Markdown

Appwrite Website

Project ID: 69d7efb00023389e8d27

Sites (1)
Site Status Logs Preview QR
 website
69d7f2670014e24571ca
Ready Ready View Logs Preview URL QR Code

Website (appwrite/website)

Project ID: 684969cb000a2f6c0a02

Sites (1)
Site Status Logs Preview QR
 website
68496a17000f03d62013
Queued Queued View Logs Preview URL QR Code


Tip

HTTPS and SSL certificates are handled automatically for all your Sites

@greptile-apps

greptile-apps Bot commented Aug 17, 2026 •

Copy link
Copy Markdown
Contributor

Greptile Summary

The PR updates credential-creation guidance to match Cloud restrictions and retires documentation for minting replacement credentials.

  • Replaces client-side JWT creation examples with Server SDK users.createJWT examples.
  • Removes Project API examples for creating long-lived API keys while retaining management and ephemeral-key guidance.
  • Redirects the retired key-rotation guide and adds a changelog entry explaining the policy change.

Confidence Score: 5/5

The PR appears safe to merge.

No blocking failure remains.

Important Files Changed

Filename Overview
src/routes/docs/products/auth/jwt/+page.markdoc Replaces client Account JWT creation with Server SDK Users examples and updates the surrounding JWT workflow.
src/routes/docs/partners/project/api-keys/+page.markdoc Removes long-lived key creation examples and clarifies the remaining key-management and ephemeral-key operations.
src/routes/docs/partners/project/key-rotation/+page.markdoc Deletes the obsolete programmatic key-rotation guide, coordinated with navigation and redirect updates.
src/redirects.json Redirects the retired key-rotation route to the API keys documentation.
src/routes/changelog/(entries)/2026-08-17.markdoc Adds the dated changelog announcement for the API key and JWT credential-minting restrictions.

Reviews (4): Last reviewed commit: "docs: rephrase changelog so leaked crede..." | Re-trigger Greptile

The guide depended on minting long-lived keys from the API, which Cloud no longer allows.

@adityaoberai adityaoberai left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Took a quick glance, just one comment there

Comment thread src/routes/docs/apis/rest/+page.markdoc Outdated
@atharvadeosthale
atharvadeosthale merged commit 2357127 into main Aug 17, 2026
6 of 7 checks passed
@atharvadeosthale
atharvadeosthale deleted the docs/remove-key-jwt-create-methods branch August 17, 2026 07:07
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants