Skip to content

Projects API#2926

Open
atharvadeosthale wants to merge 19 commits into
mainfrom
projects-api
Open

Projects API#2926
atharvadeosthale wants to merge 19 commits into
mainfrom
projects-api

Conversation

@atharvadeosthale
Copy link
Copy Markdown
Member

No description provided.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Apr 28, 2026

Greptile Summary

This PR introduces a new platforms/project documentation section covering project-level settings (auth methods, OAuth providers, API keys, platforms, protocols, services, policies, mock phones, environment variables, SMTP, email templates, and labels), each with Console instructions and multi-language Server SDK code examples. Two existing pages (api-keys and environment-variables) are moved from advanced/platform to the new section, with redirects added for both old URLs.

  • New src/routes/docs/platforms/project/ section with 13 Markdoc pages, a Svelte layout/sidebar, and corresponding AVIF screenshots for light and dark themes.
  • advanced/platform sidebar and overview page updated to remove the two relocated entries; redirects.json updated with 2 new redirects and an updated /docs/keys shortcut.
  • .optimize-cache.json updated with hashes for new images, though the entries reference .png paths while the committed files are .avif, and the create-api-key images are absent from the cache update.

Confidence Score: 5/5

This PR is safe to merge — it adds documentation-only content and performs a clean URL migration with correct redirects for all relocated pages.

All changes are documentation pages, navigation wiring, redirects, and static image assets. The redirect chain for both moved pages is correct, no existing URL is broken without a redirect, and no application logic is touched. The only findings are a carried-over grammar typo and a cache-file extension mismatch that does not affect rendered content.

.optimize-cache.json has mismatched extensions (PNG entries for AVIF files) and is missing entries for create-api-key images — worth a second look if the image-optimization pipeline runs in CI.

Important Files Changed

Filename Overview
src/redirects.json Adds redirects for the two moved pages (api-keys, environment-variables) and updates the /docs/keys shortcut to point at the new URL.
src/routes/docs/Sidebar.svelte Adds a new top-level "Platforms" section to the docs sidebar with a single "Project" parent link.
src/routes/docs/advanced/platform/+layout.svelte Removes the "API keys" and "Environment variables" nav items that were moved to platforms/project.
src/routes/docs/advanced/platform/+page.markdoc Removes the API keys card from the platform overview page since the content was relocated.
src/routes/docs/platforms/project/+layout.svelte New layout for the platforms/project section with sidebar navigation covering all 12 project-settings sub-pages.
src/routes/docs/platforms/project/+page.markdoc New overview page for the Project section with cards linking to all 12 sub-pages and a multi-SDK project.get() example.
src/routes/docs/platforms/project/api-keys/+page.markdoc New API keys reference page (moved from advanced/platform/api-keys) with full CRUD SDK examples; carries over a minor grammar typo on line 8.
.optimize-cache.json Cache updated with PNG hashes for images that are actually committed as AVIF; create-api-key images are missing from the cache update entirely.

Reviews (14): Last reviewed commit: "docs: add project labels page and docume..." | Re-trigger Greptile

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
# 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.
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.

1 participant