Skip to content

feat: API specs update for version latest#64

Open
appwrite-specs[bot] wants to merge 1 commit intomainfrom
feat-latest-specs
Open

feat: API specs update for version latest#64
appwrite-specs[bot] wants to merge 1 commit intomainfrom
feat-latest-specs

Conversation

@appwrite-specs
Copy link
Copy Markdown

@appwrite-specs appwrite-specs Bot commented May 7, 2026

This PR contains API specification updates for version latest.

@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented May 7, 2026

Greptile Summary

This PR bumps all six API specs from version 1.9.3 to 1.9.4, introducing new proxy rule management endpoints, bigint attribute/column endpoints, and several breaking renames in the console spec.

  • New server endpoints: Full proxy rule CRUD (proxyListRules, proxyCreateAPIRule, proxyCreateFunctionRule, proxyCreateRedirectRule, proxyCreateSiteRule, proxyGetRule, proxyDeleteRule, proxyUpdateRuleStatus) plus a new proxyRule schema, tablesDBCreateBigIntColumn, tablesDBUpdateBigIntColumn, and deprecated databasesCreateBigIntAttribute/databasesUpdateBigIntAttribute.
  • Type mismatch in proxyCreateRedirectRule: The request body defines statusCode as type: \"string\" with an enum of HTTP codes, while the proxyRule response schema defines redirectStatusCode as type: \"integer\". SDK generators will produce mismatched types for the same value across both open-api3-latest-server.json and swagger2-latest-server.json.
  • Console breaking changes (previously flagged): proxyUpdateRuleVerification renamed to proxyUpdateRuleStatus, suggestQueries parameter typeresource, and \"created\" removed from the proxy rule status enum.

Confidence Score: 3/5

The new redirect rule endpoint has a type mismatch between request and response that will cause SDK generation issues.

The proxyCreateRedirectRule endpoint defines statusCode as a string in the request body but redirectStatusCode as an integer in the proxyRule response schema, producing mismatched SDK types across both server spec formats.

specs/latest/open-api3-latest-server.json and specs/latest/swagger2-latest-server.json — the statusCode/redirectStatusCode type alignment needs resolution before SDK generation.

Important Files Changed

Filename Overview
specs/latest/open-api3-latest-server.json Version bumped to 1.9.4; new proxy rule management endpoints added; type mismatch between statusCode (string) in create redirect rule request and redirectStatusCode (integer) in proxyRule response schema
specs/latest/open-api3-latest-console.json New bigint attribute and column endpoints added; proxyUpdateRuleVerification renamed to proxyUpdateRuleStatus (breaking); suggestQueries parameter type renamed to resource (breaking); "created" removed from proxyRule status enum (breaking)
specs/latest/open-api3-latest-client.json Version bumped to 1.9.4; endpoint weight values updated; no structural or breaking changes
specs/latest/swagger2-latest-server.json Mirror of open-api3-latest-server.json changes; same type mismatch for statusCode (string) vs redirectStatusCode (integer) present here as well
specs/latest/swagger2-latest-console.json Mirror of open-api3-latest-console.json changes; same breaking renames present
specs/latest/swagger2-latest-client.json Mirror of open-api3-latest-client.json; weight-only updates, no structural changes

Reviews (3): Last reviewed commit: "chore: update API specs and SDK examples" | Re-trigger Greptile

Comment thread specs/latest/open-api3-latest-console.json
@appwrite-specs appwrite-specs Bot force-pushed the feat-latest-specs branch from 287104a to b180840 Compare May 7, 2026 11:31
@@ -1,7 +1,7 @@
{
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Breaking path rename: /proxy/rules/{ruleId}/verification/proxy/rules/{ruleId}/status

The endpoint path, operationId (proxyUpdateRuleVerificationproxyUpdateRuleStatus), and SDK method name (updateRuleVerificationupdateRuleStatus) all changed in the same commit. Any existing console SDK client that calls PATCH /v1/proxy/rules/{ruleId}/verification will receive a 404 at runtime. The same rename appears in swagger2-latest-console.json. This should be coordinated with a corresponding console SDK release, or the old path should be preserved as a deprecated alias during a transition period.

@@ -1,7 +1,7 @@
{
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Removed "created" value from rule status enum

The status field of the proxyRule schema previously enumerated four values: "created", "verifying", "verified", "unverified". This PR drops "created" down to three values. Any console client that reads a rule object and branches on status === "created" will now silently fall through to its default/unknown branch. The same change appears in swagger2-latest-console.json. If the server still returns "created" for older rule objects, clients following the new spec will mishandle those responses.

@appwrite-specs appwrite-specs Bot force-pushed the feat-latest-specs branch from b180840 to c73222d Compare May 7, 2026 13:17
Comment on lines +37143 to +37159
"statusCode": {
"type": "string",
"description": "Variable value. Max length: 8192 chars.",
"x-example": "<VALUE>"
"description": "Status code of redirection",
"x-example": "301",
"enum": [
"301",
"302",
"307",
"308"
],
"x-enum-name": null,
"x-enum-keys": [
"Moved Permanently 301",
"Found 302",
"Temporary Redirect 307",
"Permanent Redirect 308"
]
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Type mismatch: statusCode request parameter vs redirectStatusCode response field

The proxyCreateRedirectRule request body defines statusCode as type: "string" (line 37143), while the proxyRule response schema defines redirectStatusCode as type: "integer" (line 70863). SDK generators will produce mismatched types for the same conceptual value — callers must pass the string "301" but will receive back the integer 301. The same mismatch is present in swagger2-latest-server.json. Either both should be strings (with the enum on the request side) or both should be integers.

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.

0 participants