Skip to content

feat: API specs update for version 2.4.x - #125

Merged
ChiragAgg5k merged 1 commit into
mainfrom
feat-2.4.x-specs
Oct 8, 2026
Merged

ChiragAgg5k merged 1 commit into
mainfrom
feat-2.4.x-specs

Conversation

@appwrite-specifications

Copy link
Copy Markdown
Contributor

This PR contains API specification updates for version 2.4.x.

@hansi-codes

hansi-codes Bot commented Oct 8, 2026

Copy link
Copy Markdown

🔵 Tier A · Mergeable after minor fixes

The issues are confined to generated documentation examples and are minor, but should be corrected before relying on the snippets as copy-pasteable examples.

This PR adds the 2.4.x API specification and generated SDK example set, covering updated endpoints across client and server SDKs. The new examples include account, apps, databases, avatars, OAuth2, and other API groups.

15519 of 15665 changed files were too large to include in full.

Verdict New comments Fixed Still open
💬 Commented 2 0 0

Note

@appwrite-specifications[bot] does not have write access to this repository, so Hansi does not approve automatically. A maintainer can review and approve.

Finding Where
🟡 Import java.util.List in the Java example examples/2.4.x/client-android/java/account/list-consents.md:15
🟡 Pass screenshot permissions as a list examples/2.4.x/client-android/java/avatars/get-screenshot.md:35
Fix with agent prompt
### Issue 1
examples/2.4.x/client-android/java/account/list-consents.md:15
**Import `java.util.List` in the Java example**

This snippet uses `List.of()` but its imports omit `java.util.List` (and other Java examples also use `Map` without importing it). Copying the example into a Java source file as written fails to compile with an unresolved `List` symbol.

### Issue 2
examples/2.4.x/client-android/java/avatars/get-screenshot.md:35
**Pass screenshot permissions as a list**

The OpenAPI parameter `permissions` is an array of `BrowserPermission` values (see `specs/2.4.x/open-api3-2.4.x.json` around line 17682), but this example passes a single enum value. The Android Java example therefore does not match the request shape; the corresponding Kotlin example has the same scalar argument.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.
📂 Walkthrough · 2
File Change
examples/2.4.x/** Adds generated API usage examples across supported SDKs and platforms.
specs/2.4.x/open-api3-2.4.x.json Adds the OpenAPI 3 specification for API version 2.4.x.

Reviewed 22270ac · Details · Comment @hansi-codes review to re-run, or mention @hansi-codes with a question.

@hansi-codes hansi-codes Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🔵 Tier A · See the inline comments. Summary

Account account = new Account(client);

account.listConsents(
List.of(), // queries (optional)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Import java.util.List in the Java example

This snippet uses List.of() but its imports omit java.util.List (and other Java examples also use Map without importing it). Copying the example into a Java source file as written fails to compile with an unresolved List symbol.

Prompt To Fix With AI
This is a comment left during a code review.
Path: examples/2.4.x/client-android/java/account/list-consents.md
Line: 15

Comment:
**Import `java.util.List` in the Java example**

This snippet uses `List.of()` but its imports omit `java.util.List` (and other Java examples also use `Map` without importing it). Copying the example into a Java source file as written fails to compile with an unresolved `List` symbol.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

🟡 Minor · documentation · Reply if this doesn't apply.

-122.4194, // longitude (optional)
100.0, // accuracy (optional)
true, // touch (optional)
BrowserPermission.GEOLOCATION, // permissions (optional)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pass screenshot permissions as a list

The OpenAPI parameter permissions is an array of BrowserPermission values (see specs/2.4.x/open-api3-2.4.x.json around line 17682), but this example passes a single enum value. The Android Java example therefore does not match the request shape; the corresponding Kotlin example has the same scalar argument.

Prompt To Fix With AI
This is a comment left during a code review.
Path: examples/2.4.x/client-android/java/avatars/get-screenshot.md
Line: 35

Comment:
**Pass screenshot permissions as a list**

The OpenAPI parameter `permissions` is an array of `BrowserPermission` values (see `specs/2.4.x/open-api3-2.4.x.json` around line 17682), but this example passes a single enum value. The Android Java example therefore does not match the request shape; the corresponding Kotlin example has the same scalar argument.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

🟡 Minor · documentation · Reply if this doesn't apply.

@ChiragAgg5k
ChiragAgg5k merged commit 0a012b5 into main Oct 8, 2026
2 checks passed
@ChiragAgg5k
ChiragAgg5k deleted the feat-2.4.x-specs branch October 8, 2026 10:55
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