Support for schema description?
Open
- Dominant language
- Python
- Stars
- 652
- Forks
- 151
- PR merge metrics
- No merged PRs in 30d
Description
Is it possible to provide class-level documentation (what is a particular schema class for?)
I don't see how this is done here:
https://github.com/jmcarp/flask-apispec/blob/master/examples/petstore.py
Looking at the implementation of the annotation function, description fields can be passed for methods, and fields, but I don't see how to document classes.
(Open API/swagger support it)
https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#responseObject
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.