Projects API by atharvadeosthale · Pull Request #2926 · appwrite/website

atharvadeosthale · 2026-04-28T10:59:03Z

No description provided.

greptile-apps · 2026-04-28T11:01:17Z

Greptile Summary

This PR adds the Projects API documentation and announcement content. The main changes are:

New Projects API blog post and changelog entry.
New Partner Project docs section, pages, sidebar entries, and redirects.
Project screenshot and blog cover assets with optimizer cache entries.
curl and hurl code-fence labels and highlighting mappings.

Confidence Score: 5/5

This looks safe to merge.

No blocking issues found in the changed code.

Important Files Changed

Filename	Overview
.optimize-cache.json	Adds optimizer cache entries for the Projects API blog cover and project documentation screenshots.
src/routes/blog/post/announcing-projects-api/+page.markdoc	Adds the Projects API announcement blog post.
src/routes/changelog/(entries)/2026-07-22-projects-api.markdoc	Adds the Projects API changelog entry.
src/routes/docs/partners/project/+layout.svelte	Adds the sidebar structure for the Partner Project docs section.
src/redirects.json	Redirects old API key and environment-variable docs URLs to the new Project docs pages.
src/lib/utils/code.ts	Adds syntax-highlighting mappings for `curl` and `hurl` code fences.
src/lib/utils/references.ts	Adds display labels for `curl` and `hurl` code fences.

_{Reviews (28): Last reviewed commit: "Merge remote-tracking branch 'origin/mai..." | Re-trigger Greptile}

# Conflicts: # .optimize-cache.json # src/routes/docs/products/project/api-keys/+page.markdoc # static/images/docs/project/create-api-key.png # static/images/docs/project/dark/create-api-key.png

- Rename stale enum classes to Project-prefixed names across all SDK language blocks: Scopes->ProjectKeyScopes (api-keys), AuthMethod->ProjectAuthMethodId (auth-methods), ProtocolId->ProjectProtocolId (protocols), ServiceId->ProjectServiceId (services); fix Python enum import path - Replace mock-phones Errors table with a Benefits section to match sibling project pages

…ist/get policy) - api-keys: add Create an ephemeral key section (createEphemeralKey), using tables.read/tables.write scopes - platforms: add Get a platform section (getPlatform) - policies: add List policies and Get a policy sections (listPolicies, getPolicy) All code blocks verified against a local Cloud with the published node-appwrite and appwrite (Rust) SDKs.

- New page documenting the project OAuth2 endpoints: per-provider updateOAuth2<Provider>, listOAuth2Providers, getOAuth2Provider - Console section with light/dark screenshots - Provider table mapping all 42 providers to their method and credential field names (App ID / App secret / extra fields) - Documents that enabling a provider validates credentials end-to-end and throws on invalid creds - Sidebar entry after Auth methods Node, Rust, and CLI examples verified against a local Cloud.

- Move /docs/advanced/platform/environment-variables to /docs/products/project/environment-variables - Add redirect from the old path to the new one - Update platform and project sidebars

- Relocate /docs/products/project/* to /docs/platforms/project/* - Add a Platforms category in the docs sidebar below Products and move Project into it - Update section sidebar hrefs and overview cards to the new path - Repoint existing redirects that targeted /docs/products/project/* to /docs/platforms/project/*

Unreferenced screenshot accidentally committed to the repo root; the mock phones page uses static/images/docs/project/dark/mock-phones.avif.

Document listing, getting, and updating custom email templates via the Console, Server SDKs (all languages), and CLI. Node and Rust blocks plus all three CLI commands verified against a local Cloud. Includes a template types reference, locales note, and benefits section, with light and dark Console screenshots.

Document configuring a custom SMTP server and sending a test email via the Console, Server SDKs (all languages), and CLI. Node, Rust, and the CLI commands verified against a local Cloud with real delivery to MailDev. Also add required-scope info boxes to the SMTP, email templates, and environment variables pages to match the other project pages, and add overview cards for OAuth providers, environment variables, SMTP, and email templates.

Add a Labels page documenting updateLabels via the Console, Server SDKs, and CLI, with a note on reading labels through project.get. Node, Rust, and the CLI command verified against a local Cloud. Also document project.get in a "Retrieve your project" section on the project overview, and add the Labels card and sidebar entry.

…section auth-methods: the SDK method is updateAuthMethod, not updateProjectAuthMethodId (corrected across node, deno, php, dotnet, dart, kotlin, java, go); and the Node enum member is ProjectAuthMethodId.Emailpassword, not EmailPassword (Node/Deno). oauth: the Node method is updateOAuth2GitHub, not updateOAuth2Github. Verified against the published node-appwrite and rust SDKs and run against a local Cloud. Non-Node languages were already correct.

Add a "Delete a project" section with a prominent destructive warning, covering all Server SDKs and the CLI. Verified that delete returns 204 and removes the project in Node, Rust, and the CLI against a local Cloud.

Announce the Projects API with all-language examples (createWebPlatform and updateProtocol), verified in Node and Rust. Cover path is referenced but intentionally left empty for now.

Add five journey pages under platforms/project: provisioning, key rotation, branded emails, plan tiers, and offboarding. Add a Journeys group to the project sidebar, and a 'Built for platform teams' section plus Journeys cards to the project overview. Update the policies page required scope to the current project.policies.write.

… page Documents updatePasswordStrengthPolicy and the deny-aliased/disposable/free-email policies with examples across all server SDKs and the CLI. Claude-Session: https://claude.ai/code/session_011RByzUgcgGo8F6mFouRG3g

Rename docs/platforms/project to docs/partners/project, update the inbound docs/blog links, rename the sidebar group from Platforms to Partners, and repoint the five redirect targets (api-keys, environment-variables) to the new path. The old advanced/platform redirect block is unchanged. Claude-Session: https://claude.ai/code/session_011RByzUgcgGo8F6mFouRG3g

Remove the plan-tiers and offboarding guides, rename the Journeys nav group to Guides, and clean up the cross-links that pointed at the removed pages. Add the Projects API cover image to the blog, create a matching changelog entry, and set both to 2026-07-01. Claude-Session: https://claude.ai/code/session_011RByzUgcgGo8F6mFouRG3g

adityaoberai · 2026-07-21T11:54:46Z

@atharvadeosthale let's just check the Greptile comments

Have we verified all the code samples? If not, let's do that.

adityaoberai

Approving to unblock @atharvadeosthale

Please ensure all comments are resolved

adityaoberai · 2026-07-21T11:51:22Z

Do we need to mark anything as new?

adityaoberai · 2026-07-21T11:56:02Z

+
+This is part of a wider effort to make everything in Appwrite accessible through the API. Our goal is to ensure that any action you can perform in the Appwrite Console can also be done programmatically, giving you full control over your projects through code.
+
+# Why this matters


Let's widen the scope of this, explicitly mention the "Partners" perspective

adityaoberai · 2026-07-21T11:56:46Z

+
+Every setting maps to a method on the `Project` service, available across all Server SDKs with the matching object or named parameters.
+
+# Full SDK support


Let's combine this and the get started sections

adityaoberai · 2026-07-21T11:57:39Z

+2. Initialize a Server SDK with your API key.
+3. Use the `Project` service to configure your project from code.
+
+# Resources


Do we need all these links? Can we not just use the Projects API docs here and link Discord or something else instead?

atharvadeosthale · 2026-07-21T12:30:42Z

@atharvadeosthale let's just check the Greptile comments

Have we verified all the code samples? If not, let's do that.

Code blocks have been verified

…ons, trimmed resources - Replace blog cover with new artwork - Add Partner workflows bullet to Why this matters - Merge Full SDK support into Get started, trim Resources to docs + Discord - Move blog and changelog dates to 2026-07-21 - Restore platform create-api-key screenshots still referenced on main - Add missing optimize-cache entries for project create-api-key images Claude-Session: https://claude.ai/code/session_01SP9ik1aGqQ2BtzY9b8bRRX

Claude-Session: https://claude.ai/code/session_01SP9ik1aGqQ2BtzY9b8bRRX

… first

atharvadeosthale added 2 commits April 27, 2026 23:46

feat auth methods api

c7d46c8

add missing page

22523cc

greptile-apps Bot reviewed Apr 28, 2026

View reviewed changes

Comment thread src/routes/blog/post/announcing-auth-methods-api/+page.markdoc Outdated

Comment thread src/routes/blog/post/announcing-auth-methods-api/+page.markdoc

atharvadeosthale added 21 commits April 28, 2026 16:31

remove announcement blog and changelog

26b7433

platforms api docs

c6097bd

protocols and services docs + add scopes for other docs pages

f129f7b

policies docs

ef9b09a

move project to it's own project section

e29dce5

mock phone api

9a8a762

Merge remote-tracking branch 'origin/main' into projects-api

c105ed4

# Conflicts: # .optimize-cache.json # src/routes/docs/products/project/api-keys/+page.markdoc # static/images/docs/project/create-api-key.png # static/images/docs/project/dark/create-api-key.png

chore: optimize project docs images to AVIF

af15f30

docs: move environment variables page from platform to project section

23c5e36

- Move /docs/advanced/platform/environment-variables to /docs/products/project/environment-variables - Add redirect from the old path to the new one - Update platform and project sidebars

chore: remove stray mock-phones-dark.png from repo root

fc1e28a

Unreferenced screenshot accidentally committed to the repo root; the mock phones page uses static/images/docs/project/dark/mock-phones.avif.

docs: document project.delete on the project overview

a8d6837

Add a "Delete a project" section with a prominent destructive warning, covering all Server SDKs and the CLI. Verified that delete returns 204 and removes the project in Node, Rust, and the CLI against a local Cloud.

blog: add Projects API announcement

2a40d9a

Announce the Projects API with all-language examples (createWebPlatform and updateProtocol), verified in Node and Rust. Cover path is referenced but intentionally left empty for now.

greptile-apps Bot reviewed Jun 17, 2026

View reviewed changes

Comment thread src/routes/blog/post/announcing-projects-api/+page.markdoc

adityaoberai and others added 4 commits June 23, 2026 05:11

Merge branch 'main' into projects-api

57e5e4a

Merge branch 'main' into projects-api

c14b70b

atharvadeosthale and others added 3 commits July 1, 2026 19:07

Merge branch 'main' into projects-api

054644f

Merge branch 'main' into projects-api

5da6904

greptile-apps Bot reviewed Jul 21, 2026

View reviewed changes

Comment thread .optimize-cache.json

adityaoberai approved these changes Jul 21, 2026

View reviewed changes

atharvadeosthale added 5 commits July 21, 2026 18:10

Add partners framing to blog and mark Project docs entry as new

306f6af

Claude-Session: https://claude.ai/code/session_01SP9ik1aGqQ2BtzY9b8bRRX

Move Projects API blog and changelog date to July 22

49ca786

Rename changelog entry to avoid same-date filename collision and sort…

ea2201e

… first

Merge remote-tracking branch 'origin/main' into projects-api

a7681d8

atharvadeosthale merged commit f47d842 into main Jul 22, 2026
7 checks passed

atharvadeosthale deleted the projects-api branch July 22, 2026 06:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Projects API#2926

Projects API#2926
atharvadeosthale merged 35 commits into
mainfrom
projects-api

atharvadeosthale commented Apr 28, 2026

Uh oh!

greptile-apps Bot commented Apr 28, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

adityaoberai commented Jul 21, 2026

Uh oh!

Uh oh!

adityaoberai left a comment

Uh oh!

adityaoberai Jul 21, 2026

Uh oh!

Uh oh!

adityaoberai Jul 21, 2026

Uh oh!

adityaoberai Jul 21, 2026

Uh oh!

adityaoberai Jul 21, 2026

Uh oh!

atharvadeosthale commented Jul 21, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants


		This is part of a wider effort to make everything in Appwrite accessible through the API. Our goal is to ensure that any action you can perform in the Appwrite Console can also be done programmatically, giving you full control over your projects through code.

		# Why this matters


		Every setting maps to a method on the `Project` service, available across all Server SDKs with the matching object or named parameters.

		# Full SDK support

Uh oh!

Conversation

atharvadeosthale commented Apr 28, 2026

Uh oh!

greptile-apps Bot commented Apr 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Greptile Summary

Confidence Score: 5/5

Important Files Changed

Uh oh!

Uh oh!

Uh oh!

Uh oh!

adityaoberai commented Jul 21, 2026

Uh oh!

Uh oh!

adityaoberai left a comment

Choose a reason for hiding this comment

Uh oh!

adityaoberai Jul 21, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

adityaoberai Jul 21, 2026

Choose a reason for hiding this comment

Uh oh!

adityaoberai Jul 21, 2026

Choose a reason for hiding this comment

Uh oh!

adityaoberai Jul 21, 2026

Choose a reason for hiding this comment

Uh oh!

atharvadeosthale commented Jul 21, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

greptile-apps Bot commented Apr 28, 2026 •

edited

Loading