Skip to content

Add docs for public project platforms and API keys APIs#2879

Closed
atharvadeosthale wants to merge 1 commit intomainfrom
feat/public-project-apis-docs
Closed

Add docs for public project platforms and API keys APIs#2879
atharvadeosthale wants to merge 1 commit intomainfrom
feat/public-project-apis-docs

Conversation

@atharvadeosthale
Copy link
Copy Markdown
Member

Summary

  • New changelog entry (2026-04-10): Announces public project APIs for platforms and API keys, consolidated platform types, and new scopes
  • New docs page (/docs/advanced/platform/platforms): Full coverage of the platforms API — types, endpoints, SDK examples, scopes, and migration notes for deprecated platform types (flutter-ios, apple-macos, etc. → web, apple, android, windows, linux)
  • Updated API keys docs (/docs/advanced/platform/api-keys): Added "Manage keys with the API" section with endpoint table and SDK examples; added 8 new scopes to the scopes table (webhooks.read/write, project.read/write, keys.read/write, platforms.read/write)
  • Updated platform navigation: Added Platforms link to sidebar and overview cards

Test plan

  • Verify the new /docs/advanced/platform/platforms page renders correctly
  • Verify the changelog entry at /changelog for 2026-04-10 renders correctly
  • Verify the updated API keys scopes table includes all new scopes
  • Verify the "Manage keys with the API" section renders with proper code blocks
  • Verify the "Platforms" link appears in the platform sidebar navigation with a "new" badge
  • Verify the Platforms card appears on the platform overview page

🤖 Generated with Claude Code

Cover the new public project APIs: platforms CRUD (web, apple, android,
windows, linux), API keys CRUD, new scopes (platforms, keys, webhooks,
project), and migration notes for deprecated platform types.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@appwrite
Copy link
Copy Markdown

appwrite bot commented Apr 10, 2026

Appwrite Website

Project ID: 69d7efb00023389e8d27

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

Website (appwrite/website)

Project ID: 684969cb000a2f6c0a02

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


Tip

Preview deployments create instant URLs for every branch and commit

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Apr 10, 2026

Greptile Summary

This PR adds a new /docs/advanced/platform/platforms page, expands the API keys docs with a "Manage keys with the API" section and 8 new scopes, updates sidebar navigation, and adds a changelog entry for 2026-04-10. The content is well-structured and consistent across files, with one factual error in the changelog: it states "Six new scope pairs" but lists only four pairs (eight individual scopes).

Confidence Score: 4/5

Safe to merge after correcting the scope count in the changelog entry.

A single P1 factual error in the changelog ("Six new scope pairs" vs. the four pairs actually listed) keeps the score at 4. All other files are accurate and well-formed.

src/routes/changelog/(entries)/2026-04-10.markdoc — incorrect scope pair count in the prose.

Important Files Changed

Filename Overview
src/routes/changelog/(entries)/2026-04-10.markdoc New changelog entry announcing public project APIs; contains a factual error — "Six new scope pairs" is listed but only four pairs are enumerated.
src/routes/docs/advanced/platform/platforms/+page.markdoc New Platforms API docs page covering platform types, CRUD endpoints, scopes, and migration notes for deprecated types; well-structured and accurate.
src/routes/docs/advanced/platform/api-keys/+page.markdoc Adds "Manage keys with the API" section with endpoint table and Node.js/Python SDK examples; adds 8 new scopes to the scopes table.
src/routes/docs/advanced/platform/+layout.svelte Adds Platforms link to the Access control nav section with isNewUntil badge set to 10 Jul 2026; looks correct.
src/routes/docs/advanced/platform/+page.markdoc Adds Platforms card to the Access control section of the platform overview page; looks correct.

Reviews (1): Last reviewed commit: "Add docs and changelog for public projec..." | Re-trigger Greptile

Comment on lines +21 to +27
Six new scope pairs are now available for API keys:

- `platforms.read` / `platforms.write` -- manage project platforms
- `keys.read` / `keys.write` -- manage project API keys
- `webhooks.read` / `webhooks.write` -- manage project webhooks
- `project.read` / `project.write` -- read and update project information

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.

P1 Incorrect scope pair count

The text says "Six new scope pairs" but the bullet list that follows enumerates exactly four pairs (platforms, keys, webhooks, project) — eight individual scopes in total. This matches the PR description ("8 new scopes") and the updated scopes table in the API keys docs, so the prose count is the error.

Suggested change
Six new scope pairs are now available for API keys:
- `platforms.read` / `platforms.write` -- manage project platforms
- `keys.read` / `keys.write` -- manage project API keys
- `webhooks.read` / `webhooks.write` -- manage project webhooks
- `project.read` / `project.write` -- read and update project information
Four new scope pairs are now available for API keys:

@atharvadeosthale atharvadeosthale deleted the feat/public-project-apis-docs branch April 10, 2026 17:24
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