swr-request-generator icon indicating copy to clipboard operation
swr-request-generator copied to clipboard

[Feature request] Make use of summary/description fields in OpenAPI spec to provide comments.

Open SudoHenk opened this issue 3 years ago • 1 comments

Hi, First of all, thanks for writing this plugin.

I'm currently working in a multi-disciplinary team of front- and backenders, and it would be really useful if the generator also generates comments in the Typescript result (both for the types and the endpoints). The OpenAPI specification supports this with the help of "summary" and "description" fields.

SudoHenk avatar Jan 18 '23 08:01 SudoHenk

Hi @SudoHenk , it will be useful if you can provide a piece of data to describe what results you want from 'summary' and 'description' fields. just like:

  • a json/yaml data for summary and description for a request and schema
  • what should commants like in the code

teobler avatar Feb 08 '23 07:02 teobler