add better OpenAPI response definitions
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 37.4k
- Forks
- 3k
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 73
Description
What problem will this feature address?
i'd like to implement a terraform provider for dokploy, but that's a bit difficult when the shapes of the JSON responses are unknown.
Describe the solution you'd like
i'd like for the OpenAPI spec to include the actual shapes of responses, as opposed to a plain, generic successful response string.
Describe alternatives you've considered
i noticed that in the trpc-openapi package, there's an .output function that takes a Zod object as its argument. maybe you could update the API procedures to make use of this?
Additional context
No response
Will you send a PR to implement it?
Maybe, need help
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by examining the API procedures and how the trpc-openapi package's .output function is used or could be used with their response schemas. Done means the generated OpenAPI specification describes actual JSON response shapes instead of generic successful-response strings, including coverage across the relevant procedures.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, typescript
- Domain
- api, backend-api-design
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100