Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

chore: switch docs specs source to @appwrite.io/specs#2751

Merged
ChiragAgg5k merged 1 commit intomain from
chore/use-appwrite-specs-package
Feb 18, 2026
Merged

chore: switch docs specs source to @appwrite.io/specs #2751
ChiragAgg5k merged 1 commit intomain from
chore/use-appwrite-specs-package

Conversation

@ChiragAgg5k
Copy link
Member

@ChiragAgg5k ChiragAgg5k commented Feb 18, 2026
edited by coderabbitai bot
Loading

Related

  • #XXXX

Summary

  • replace dependency from @appwrite.io/repo to @appwrite.io/specs
  • update docs spec and example imports in specs.ts to load from @appwrite.io/specs
  • update Vite dynamic import filter and release instructions to reflect the new package

Type of Change

  • Chore / maintenance
  • Bug fix
  • New feature
  • Breaking change
  • Documentation only

Testing

  • Automated tests
  • Not run (path/dependency wiring change)

Risk

  • low: import path changes only, no runtime logic changes beyond source location

Summary by CodeRabbit

  • Chores
    • Updated tooling and scripts to fetch specifications and example resources from a new "specs" source.
    • Swapped a development dependency to point to the specs package.
    • Adjusted documentation/example resource paths and build import handling to align with the new specs location.

Copy link
Contributor

coderabbitai bot commented Feb 18, 2026
edited
Loading

Warning

Rate limit exceeded

@ChiragAgg5k has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 7 minutes and 2 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Walkthrough

This pull request updates the source of API specifications from the @appwrite.io/repo package to the @appwrite.io/specs package. Changes include replacing the devDependency in package.json, updating the release script to bump the specs repository instead of the main appwrite repository, updating file path references from /repo/docs/examples to /specs/examples in the specs route handler, and modifying the vite configuration to reflect the new module import path for dynamic imports.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the main change: switching the docs specs dependency source from @appwrite.io/repo to @appwrite.io/specs, which is reflected across all modified files.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chore/use-appwrite-specs-package

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
src/routes/docs/references/[version]/[platform]/[service]/specs.ts (1)

399-411: ⚠️ Potential issue | 🔴 Critical

Critical: specs glob and getApi still reference the removed @appwrite.io/repo package.

@appwrite.io/repo is not a dependency in package.json, but lines 399–411 still resolve JSON spec files from it:

const specs = import.meta.glob(
 '/node_modules/@appwrite.io/repo/app/config/specs/open-api3*.json',
 { exhaustive: true }
);
// ...
const target = `/node_modules/@appwrite.io/repo/app/config/specs/open-api3-${version}-...json`;
return specs[target]() as unknown as OpenAPIV3.Document;

This will cause the glob to resolve to {} at build time, breaking every call to getApi() at runtime. Update the paths to use @appwrite.io/specs/specs instead:

Expected fix
const specs = import.meta.glob(
 '/node_modules/@appwrite.io/specs/specs/open-api3*.json',
 { exhaustive: true }
);
export async function getApi(version: string, platform: string): Promise<OpenAPIV3.Document> {
 const isClient = platform.startsWith('client-');
 const isServer = platform.startsWith('server-');
 const target = `/node_modules/@appwrite.io/specs/specs/open-api3-${version}-${
 isServer ? 'server' : isClient ? 'client' : 'console'
 }.json`;
 return specs[target]() as unknown as OpenAPIV3.Document;
}
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@src/routes/docs/references/`[version]/[platform]/[service]/specs.ts around
lines 399 - 411, Update the import glob path and the computed target in the
specs loader: change the import.meta.glob call referenced by the const specs and
the constructed target string inside getApi(version, platform) to point to
'/node_modules/@appwrite.io/specs/specs/open-api3*.json' (and the corresponding
open-api3-{version}-{server|client|console}.json) instead of the removed
'@appwrite.io/repo' package so that specs[target]() resolves correctly; modify
the glob pattern and target construction where the symbols specs, getApi, and
target are used.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@package.json`:
- Line 35: The release workflow is broken because package.json pins
`@appwrite.io/specs` to a specific commit hash
(`#63057a4df2f206c29e98c6de7263264b9d0d6b1c`) so the RELEASE.md step that runs
"bun update `@appwrite.io/specs`" won't move it; either change the dependency in
package.json to reference the branch (e.g., "#main") so bun update advances it,
or keep the commit-pin but update RELEASE.md to explicitly replace the commit
hash during the release and run "bun install" to refresh bun.lock; update
package.json (the `@appwrite.io/specs` entry) and RELEASE.md (the bun update step)
accordingly to match the chosen approach.
In `@RELEASE.md`:
- Around line 57-58: Update the top-level checklist item that still reads "Bump
appwrite repo so latest main commit is used" to match the updated script
comment; change that header to "Bump appwrite/specs repo so latest main commit
is used" so it aligns with the updated command line "bun update
`@appwrite.io/specs`" in the diff.
---
Outside diff comments:
In `@src/routes/docs/references/`[version]/[platform]/[service]/specs.ts:
- Around line 399-411: Update the import glob path and the computed target in
the specs loader: change the import.meta.glob call referenced by the const specs
and the constructed target string inside getApi(version, platform) to point to
'/node_modules/@appwrite.io/specs/specs/open-api3*.json' (and the corresponding
open-api3-{version}-{server|client|console}.json) instead of the removed
'@appwrite.io/repo' package so that specs[target]() resolves correctly; modify
the glob pattern and target construction where the symbols specs, getApi, and
target are used.

@ChiragAgg5k ChiragAgg5k force-pushed the chore/use-appwrite-specs-package branch from 14efe3f to 89d7a99 Compare February 18, 2026 11:30
@ChiragAgg5k ChiragAgg5k force-pushed the chore/use-appwrite-specs-package branch from 89d7a99 to 3644990 Compare February 18, 2026 12:38
@ChiragAgg5k ChiragAgg5k merged commit c125a8d into main Feb 18, 2026
6 checks passed
@ChiragAgg5k ChiragAgg5k deleted the chore/use-appwrite-specs-package branch February 18, 2026 12:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@loks0n loks0n loks0n approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Comments

AltStyle によって変換されたページ (->オリジナル) /