Ty
Ty2mo ago

Will OpenAPI swagger docs continue to be maintained?

We have recently started migrating to using a typescript axios client to communicate with the zitadel backend that is generated off of the Swagger docs hosted here https://zitadel.cloud/openapi/v2/swagger/v2/zitadel/zitadel/. But I just noticed in the release notes for v4 the following:
GRPC APIs with ConnectRPC
All new v2 APIs will exclusively leverage gRPC with ConnectRPC, discontinuing support for OpenAPI 2.0 for new endpoints. This ensures a robust, high-performance, and future-proof integration experience.
GRPC APIs with ConnectRPC
All new v2 APIs will exclusively leverage gRPC with ConnectRPC, discontinuing support for OpenAPI 2.0 for new endpoints. This ensures a robust, high-performance, and future-proof integration experience.
Can I expect that we can continue to use these openapi docs going forward or is it a mistake to build off of them?
1 Reply
Koen
Koen4w ago
i was wondering the same thing, in the user spec (the one that i could find that had actual paths instead of just nothing) has different url's for v2 than the docs page: Docs page: - /v2/users/new OpenAPI Swagger: - /v2/users/human so i was wondering what we should use as I want to automate migration from another SSO to zitadel via automatically creating the users and sending invites to all migrated users to setup a new password

Did you find this page helpful?