OpenAPI spec should include schemas for return types of http calls

docusealco / docuseal

Open source DocuSign alternative. Create, fill, and sign digital documents ✍️

https://www.docuseal.co

GNU Affero General Public License v3.0

5.61k stars 372 forks source link

OpenAPI spec should include schemas for return types of http calls #195

Closed reckter closed 3 months ago

reckter commented 5 months ago

The spec document (https://console.docuseal.co/openapi.yml) currently only includes schemas for the request parameters, but not for the returned types of the api. This means that, when generating a client with said schema, it will generate functions that return nothing (void in case of the typescript-fetch generator, I assume similar results, when using others).

I would have added schemas myself in an MR, but I don't think that yml is in any public repository?

AlexandrToorchyn commented 4 months ago

@reckter We've updated our spec document to now include comprehensive schemas that describe the types of attributes for all responses.

omohokcoj commented 3 months ago

closing this since response schemas have been already added to the openapi.yml