Include API methods/calls in the generated documentation
Author: mffapCreated May 25, 2023Updated Sep 17, 2026
Labelsarea/docsservice-layerTo-be-closed
Follow-up from: https://github.com/zitadel/zitadel/issues/5825
As a developer/user, I want to be able to search for REST/GRPC calls in our docs so that I can find and read the documentation for the corresponding call.
Why is it not working today?
- API docs are generated automatically, we use the https://github.com/PaloAltoNetworks/docusaurus-openapi-docs
- The final markdown is generated directly from the plugin
- There was no obvious way for me to crawl the rest call (method + resource path) as well as the RPCs in a consistent way from the docs page
### Acceptance Criteria
- [ ] Decision: Manually include calls in description vs. Generate automatically?
- [ ] REST method and resource path is available in the docs page (either as part of the content or tagged with a unique css class)
- [ ] RPCs are available in the docs page (either as part of the content or tagged with a unique css class)Source: zitadel/zitadel