Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Can't emit both description and summary to OpenAPI #135

Closed
nguerrera opened this issue Dec 14, 2021 · 1 comment · Fixed by #249
Closed

Can't emit both description and summary to OpenAPI #135

nguerrera opened this issue Dec 14, 2021 · 1 comment · Fixed by #249
Assignees
Milestone

Comments

@nguerrera
Copy link
Contributor

OpenAPI 2 and 3 have distinct summary and description fields, but we only have one @doc so there's no way to use both. When something takes a summary and description, we seem to use @doc as summary. And when it only takes a description we use @doc as description.

@markcowl
Copy link
Contributor

markcowl commented Jan 7, 2022

  • add @summary decorator in core to support the summary scenario
  • ensure that @doc is placed in description in openAPI emitters.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants