feat(openapi-typescript): add jsdoc comments to response object#2248
feat(openapi-typescript): add jsdoc comments to response object#2248gzm0 merged 1 commit intoopenapi-ts:mainfrom
Conversation
👷 Deploy request for openapi-ts accepted.
|
|
gzm0
left a comment
There was a problem hiding this comment.
TY very much for the contribution.
Review note: I have verified that the added examples appear verbatim in the original OpenAPI (and are not generated). As such, I am not worried about code bloat or duplicated examples. It is up to the OpenAPI author to decide at which level to add examples (object or object field, etc.).
|
Dang... We should have included a changeset here :( |
Changes
This PR adds JSDoc comments like
@exampleto response objects. We are missing them in our generated types. They are already present on request objects and in many other places.How to Review
See changes in
examples/digital-ocean-api.tsbelow.Checklist
docs/updated (if necessary)pnpm run update:examplesrun (only applicable for openapi-typescript)