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.

Sign up for GitHub

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

Jump to bottom

Add descriptions to models, parameters, fields #177

Open

ehmicky opened this issue Sep 9, 2019 · 0 comments

Labels

enhancement specification

Contributor

ehmicky commented Sep 9, 2019 •

edited

Loading

Adding descriptions to the following would be very useful for developers:

endpoints (operations):
- summary (short description)
- description (long description)
- externalDocs (link to online documentation)
request parameters
request payloads
models / schemas
security schemes
tags (description and externalDocs)

Having only the attribute names is useful but does not provide enough context.

The text was updated successfully, but these errors were encountered:

ehmicky mentioned this issue

Add code samples #192

Open

ehmicky mentioned this issue

Add summary, description and tags to all operations #1

Closed

ehmicky added enhancement specification labels

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment