Repository navigation
Generate OpenAPI definitions for HTTP API #117
Description
Problem Statement
We have a Postman collection, but updating it is a manual task.
Additionally, we have users who want to use HTTP clients but also want type safety for those clients. If we export OpenAPI definitions, we can let users generate a typed API client using their tool of choice.
Solution Brainstorm
I'm not entirely sure where in the toolchain this should live - if it's a build-time thing that generates a static file or if it becomes something that's served alongside the HTTP API. I think I'd lean towards the latter but I'm not entirely sure.
Reacted by Luke
Activity
holgerstolzenberg commentedon Nov 6, 2024
I am currently exactly facing this problem.
I started to put together a GitHub project that provides these prepackaged clients: https://github.com/ewerk/authzed-http-client
It is currently incubating but snapshot libs for Java and Typescript are already available.
Essentially it is a a collection of GitHub actions leveraging https://github.com/openapi-generators/openapitools-generator-action. It uses the OpenAPI spec file that you already create from authzed/api into authzed/go.
Please see following PR for reference: authzed/authzed-go#255
If you are interested we could shift the project into
authzedproject responsibility once it has the necessary maturity.miparnisari commentedon May 1, 2026
@tstirrat15 it looks like you are the one updating this - can you document how it is done?
https://www.postman.com/authzed/spicedb/collection/m26cqyc/authzed?sideView=agentMode was last updated by you in 2024.