API Documentation
Author: livio-aCreated Aug 29, 2023Updated Sep 17, 2026
Labelsarea/docsarea/apiservice-layerTo-be-closed
The current APIs are differently well documented (missing documentation in general, missing swagger options, swagger documentation not aligned with the gRPC method, missing options for the generated docs, ...)
We should specify what and in which way we document the API and align the existing proto files (of the resource apis) with it.
Acceptance criteria
- Specify documentation rules (to work with proto clients, swagger and docs)
- Align proto files (of resource apis)
Source: zitadel/zitadel