Skip to content

feat: API specs update for version 1.9.x#51

Merged
ChiragAgg5k merged 1 commit intomainfrom
feat-1.9.x-specs
Apr 16, 2026
Merged

feat: API specs update for version 1.9.x#51
ChiragAgg5k merged 1 commit intomainfrom
feat-1.9.x-specs

Conversation

@appwrite-specs
Copy link
Copy Markdown

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

@ChiragAgg5k ChiragAgg5k merged commit 8cecdb1 into main Apr 16, 2026
2 checks passed
@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented Apr 16, 2026

Greptile Summary

This bot-generated PR updates the 1.9.x API specs across all six files (OpenAPI 3 and Swagger 2, client/server/console). The bulk of the diff is endpoint weight reordering; the substantive changes are discriminator mappings added to polymorphic oneOf schemas (attributes, columns, platforms, algorithms) and two breaking changes in the console spec.

  • Breaking: four console log endpoints removeddocumentsDB and vectorsDB listDocumentLogs/listCollectionLogs are deleted without a prior deprecated marker, which will cause 404s for any console client calling those paths.
  • Breaking: type field now required in detectionFramework and detectionRuntime schemas — existing payloads that omit type will fail validation after this ships.

Confidence Score: 4/5

Safe to merge if the two breaking console changes are intentional for 1.9.x; otherwise the removed log endpoints and new required field need clarification.

The discriminator additions and weight adjustments are non-breaking improvements. However, four console endpoints are deleted without deprecation, and type becomes a new required field in detection schemas — both are breaking changes for existing console integrations. Score held at 4 pending confirmation that these removals are deliberate for this version.

specs/1.9.x/open-api3-1.9.x-console.json and specs/1.9.x/swagger2-1.9.x-console.json — removed endpoints and new required field.

Important Files Changed

Filename Overview
specs/1.9.x/open-api3-1.9.x-client.json Weight adjustments across all endpoints; added discriminator for algo schema (argon2/scrypt/bcrypt/etc.) in account's password hash oneOf.
specs/1.9.x/swagger2-1.9.x-client.json Weight adjustments mirroring openapi3 client; added x-discriminator for password-hash algo schema — consistent with openapi3 counterpart.
specs/1.9.x/open-api3-1.9.x-server.json Weight adjustments across all endpoints; added discriminator objects to attribute, column, platform, and algorithm oneOf schemas to enable polymorphic deserialization in code generators.
specs/1.9.x/swagger2-1.9.x-server.json Weight adjustments only; discriminator additions use x-discriminator extension (Swagger 2 format) consistent with the openapi3 server counterpart — no functional issues.
specs/1.9.x/open-api3-1.9.x-console.json Weight adjustments; discriminator additions for attribute/column/platform/algo schemas; type field added (required) to detectionFramework and detectionRuntime schemas; four console-only log endpoints removed (documentsDB and vectorsDB listDocumentLogs/listCollectionLogs).
specs/1.9.x/swagger2-1.9.x-console.json Mirrors all openapi3-console changes: weight adjustments, x-discriminator additions, type field added to detection schemas, and the same four log endpoints removed.

Comments Outside Diff (2)

  1. specs/1.9.x/open-api3-1.9.x-console.json, line 1 (link)

    P1 Four console log endpoints silently removed

    This PR removes four GET endpoints that were previously part of the console API:

    • /documentsdb/{databaseId}/collections/{collectionId}/documents/{documentId}/logs (documentsDBListDocumentLogs)
    • /documentsdb/{databaseId}/collections/{collectionId}/logs (documentsDBListCollectionLogs)
    • /vectorsdb/{databaseId}/collections/{collectionId}/documents/{documentId}/logs (vectorsDBListDocumentLogs)
    • /vectorsdb/{databaseId}/collections/{collectionId}/logs (vectorsDBListCollectionLogs)

    These endpoints are removed without any deprecation marker beforehand and without replacement. Any console client (dashboard, SDK, or integration) that calls these paths will receive a 404 after this spec ships. The same removal is mirrored in swagger2-1.9.x-console.json. Are these endpoints intentionally dropped in 1.9.x, or should they be marked deprecated: true first?

  2. specs/1.9.x/open-api3-1.9.x-console.json, line 1 (link)

    P2 type added to required in detection schemas

    Both detectionFramework and detectionRuntime schemas now list type in their required array. This is a breaking change for any SDK or client that serialises/validates these objects: existing payloads that omit type will fail schema validation after this update. The same change is in swagger2-1.9.x-console.json. Please confirm this is intentional for 1.9.x and that downstream SDK templates are prepared to handle the new required field.

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

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