API Docs and Package (craziness?)
An important prempt: Im a huge fan of your software and think its excellent in most aspects! I will continue to use it!
However 🙁
The API documentation and the @zitadel/client package are one of the most confusing doc reading experiences I've had. I understand that there is a transition from the old serviced based API to new resource based. However, the version names and tags in the docs and packages are admittedly a little insane.
For example, im still not sure where I need to import the client from for
This is found in the docs on https:// zitadel (dot) /docs/apis/resources/project_service_v2/zitadel-project-v-2-beta-project-service-create-project Which on the sidebar indicates V2 (not V1 as that is the legacy API. So, where is the client? I have 1.3.1 @zitadel/client but it lacks a v2beta client file/ exports. V1 has one reference to making projects in management API, but its deprecated. I see the proto package at least some references to it.
My question is: is it me skill issueing myself here? What am I missing - what is the purpose of the client package? Is it deprecated? If I cannot use it to interact with zitadel, what should I do? Raw use the proto package? Use the node package?
I feel like im missing something.
Again, I love the product - just very bamboozled.
4 Replies
Hi @FriendlyForeignAgent, I'm an AI assistant for ZITADEL. While a team member reviews this question, I'll see if I can find relevant sources for your question.
Answer
I wasn't able to find a direct answer, here are some relevant sources:
1. CreateProject :
Documents the v2beta CreateProject API endpoint, including request/response structure and a sample HTTP client usage, but does not specify a JavaScript/TypeScript client library or package for v2beta.
2. Migrate from v1 APIs to v2 APIs :
Explains the transition from v1 to v2 APIs, noting v2 is resource-based and REST/OpenAPI support is being phased out in favor of gRPC and Connect RPC, but does not mention a v2beta JS/TS client package.
Feel free to tag @Ask Inkeep with additional questions.
Hi @FriendlyForeignAgent we now recommend moving to https://github.com/zitadel/zitadel-node/releases This new client-library should make it easier for you to work with the API. It is currently in beta and you need to install from GH https://github.com/zitadel/zitadel-node/releases
The project https://github.com/smartive/zitadel-node is no longer maintained by us and is a third-party package.
GitHub
Releases · zitadel/zitadel-node
Official Zitadel SDK for Node. Authenticate and access Zitadel's authentication and management APIs in Node. - zitadel/zitadel-node
GitHub
GitHub - smartive/zitadel-node: ZITADEL SDK for Node.js
ZITADEL SDK for Node.js. Contribute to smartive/zitadel-node development by creating an account on GitHub.
Ah, this is excellent, thank you! This could solve all the issues.
Great product lads!
🎉 Looks like you just helped out another community member! Thanks for being so helpful <@1347541666239877234>! You're now one step closer to leveling up—keep up the amazing peer support! 🚀