Skip to content

fix: match the 2.4.x reference to the released passkey SDKs - #129

Merged
ChiragAgg5k merged 1 commit into
mainfrom
fix/2.4.x-released-sdks
Oct 12, 2026
Merged

ChiragAgg5k merged 1 commit into
mainfrom
fix/2.4.x-released-sdks

Conversation

@ChiragAgg5k

Copy link
Copy Markdown
Member

Brings specs/2.4.x in line with the SDKs released today with passkeys (appwrite-labs/cloud#6491).

Why 2.4.x

The Console's Cloud API reference doesn't read specs/latest. It reads the newest numbered folder (LATEST_EXAMPLES_VERSION in apps/console), which is 2.4.x. #128 updates latest, which only the API Explorer reads, so the reference needs the same fixes here.

Passkey policy

2.4.x was generated from the 2.4.0 tag, where project.updatePasskeyPolicy took rpId and origins. Cloud and every released SDK take rpId alone, required, and work out the origins from the project's platforms.

  • The request body, operation description and policyPasskey model now match latest. origins stays on the model as a read-only list.
  • update-passkey-policy examples come from each released SDK's docs/examples at its release tag (node 29.3.0, php 30.3.0, python 24.3.0, ruby 28.3.0, go v7.10.0, dotnet 8.3.0, kotlin 22.3.0, swift 22.3.0, rust 0.17.0, console 18.4.0, console-python 0.12.0).
  • Dart, REST and GraphQL examples are edited by hand. Dart keeps this folder's models. style instead of the SDK's.
  • Every other passkey example already matched the released SDKs.

Methods no released SDK ships

Those SDK releases were patched onto each SDK's last stable tag. These methods appear in 2.4.x but in none of the released server or client SDKs, so the reference drops them for that platform. The console platform keeps them.

Removed from Methods
server account.createEmailVerificationOTP, updateEmailVerificationOTP, createRecoveryOTP, updateRecoveryOTP, createIdTokenSession (still on client, where the SDKs ship them)
server, client avatars.updatePhoto, avatars.deletePhoto
server messaging.createAppwriteProvider, updateAppwriteProvider, project.updateOAuth2Kakao, updateOAuth2TikTok, updateOAuth2Webflow, updatePasswordPwnedPolicy

The Console's Cloud API reference reads the newest numbered spec, 2.4.x. Its passkey policy still took origins, which the SDKs released with passkeys dropped for rpId alone, and it listed server and client methods no released SDK ships yet.
@hansi-codes

hansi-codes Bot commented Oct 12, 2026

Copy link
Copy Markdown

🟢 Tier S · Ready to merge

The 2.4.x OpenAPI reference now documents passkey policy updates with a required rpId and platform-derived origins, and adjusts API platform availability to match released SDKs. The passkey update examples were refreshed to use the released SDK signatures.

Verdict New comments Fixed Still open
✅ Approved 0 0 0
📂 Walkthrough · 2
File Change
examples/2.4.x/*/project/update-passkey-policy.md Updated the language-specific examples to pass only the required relying party ID.
specs/2.4.x/open-api3-2.4.x.json Updated the passkey policy operation and model, and adjusted platform availability for methods absent from released SDKs.

Reviewed c958585 · 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 S · Looks good to merge. Summary

@ChiragAgg5k
ChiragAgg5k merged commit 06e6faf into main Oct 12, 2026
2 checks passed
@ChiragAgg5k
ChiragAgg5k deleted the fix/2.4.x-released-sdks branch October 12, 2026 18:11
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