search

bootprint / bootprint-openapi

Bootprint-module to render OpenAPI specifications, this repository has moved to https://github.com/bootprint/bootprint-monorepo/tree/master/packages/bootprint-openapi
MIT License
357 stars 48 forks source link

Summary descriptions are empty #78

Closed kristijan-ujevic closed 7 years ago

kristijan-ujevic commented 7 years ago

Is it possible to unify the description and summary in the swagger.json?

Because if i leave out summary and just add the description to an endpoint i'm left with an empty description in summary section, and vice-versa.

Can i set the tool to just use the "description" as "summary" if there is no "summary" defined in swagger.json?

nknapp commented 7 years ago

In my project, I am using the first line of description as summary. It's done while generating the swagger.json from other sources.

You could create a bootprint-module that inherits bootprint-openapi and adds a custom preprocessor to modify the input JSON. If you want, you can publish this module on npm and use it instead of bootprint-openapi.

It's currently not a thing that I would like to include into bootprint-openapi.

Let me know, if this helps.