Skip to content

Add Project service to API references#2894

Merged
ChiragAgg5k merged 2 commits intomainfrom
chirag/project-service-reference
Apr 17, 2026
Merged

Add Project service to API references#2894
ChiragAgg5k merged 2 commits intomainfrom
chirag/project-service-reference

Conversation

@ChiragAgg5k
Copy link
Copy Markdown
Member

Summary

  • Register the Project service in src/lib/utils/references.ts (Service enum + serviceMap) so it resolves on the [version]/[platform]/[service] route.
  • Add a sidebar entry (icon-cube) under APIs in src/routes/docs/references/+layout.svelte.
  • Add a service description at descriptions/project.md covering platforms, keys, and variables.
  • Bump @appwrite.io/specs to the commit that introduces the project tag in the 1.9.x server spec (the tag only exists for 1.9.x + server platforms — earlier versions and client platforms will show the existing "No endpoint found" fallback).

Test plan

  • Visit /docs/references/1.9.x/server-nodejs/project and confirm methods render (create/list/get/update/delete for platforms, keys, variables, plus email/service-status updates).
  • Confirm Project appears in the APIs sidebar on any reference page.
  • Switch platform to a client SDK (e.g. client-web) — should show "No endpoint found for this version and platform".
  • Switch version to 1.8.x on server-nodejs/project — should also show the fallback.
  • bun run check passes.

Adds the new Project service (platforms, keys, variables, project-level
settings) to the API reference sidebar and registers it in the service
map. Bumps @appwrite.io/specs to the commit that introduces the project
tag in the 1.9.x server spec.
@appwrite
Copy link
Copy Markdown

appwrite bot commented Apr 17, 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
Queued Queued View Logs Preview URL QR Code


Tip

Sites auto-generate unique domains with the pattern https://randomstring.appwrite.network

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Apr 17, 2026

Greptile Summary

This PR registers the Project service in the API reference infrastructure — adding it to the Service enum, serviceMap, and the sidebar — and bumps @appwrite.io/specs to the commit that introduces the project tag in the 1.9.x server spec. The implementation is clean and consistent with how other services (Sites, Tokens) were added. Older versions and client platforms will correctly fall through to the existing "No endpoint found" fallback.

Confidence Score: 5/5

Safe to merge — all code changes are correct and consistent with existing patterns; the one remaining comment is a P2 style suggestion.

The prior P1 concern (broken cloud version in anchor links) has been resolved by switching to 1.9.x. The only remaining finding is a P2 style suggestion about hardcoded server-nodejs in the description links, which does not affect correctness or the primary user path.

descriptions/project.md — minor platform-hardcoding in anchor links, no functional impact.

Important Files Changed

Filename Overview
src/routes/docs/references/[version]/[platform]/[service]/descriptions/project.md New description file; version-specific anchor links are now correctly pointing at 1.9.x (the cloud-version issue from prior review has been fixed), but all links hard-code server-nodejs as the platform.
src/lib/utils/references.ts Adds Project: 'project' to both the Service enum and serviceMap — clean and consistent with how other services are registered.
src/routes/docs/references/+layout.svelte Adds a "Project" entry with icon-cube to the APIs sidebar; follows the same pattern as every other sidebar item.
package.json Bumps @appwrite.io/specs commit hash to the one that adds the project tag to the 1.9.x server spec.
bun.lock Lock file updated in sync with the specs commit bump in package.json.

Reviews (2): Last reviewed commit: "fix project description anchor links to ..." | Re-trigger Greptile

Comment thread src/routes/docs/references/[version]/[platform]/[service]/descriptions/project.md Outdated
Comment thread src/routes/docs/references/[version]/[platform]/[service]/descriptions/project.md Outdated
The project service only exists in the 1.9.x server spec. The cloud
alias maps to 1.8.x which has no project endpoints, so cloud-prefixed
anchors would land on the 'No endpoint found' fallback.
@ChiragAgg5k ChiragAgg5k merged commit d29bcae into main Apr 17, 2026
6 of 7 checks passed
@ChiragAgg5k ChiragAgg5k deleted the chirag/project-service-reference branch April 17, 2026 05:42
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