It seems to be useful to add a written description to the automatically generated documentation in some cases.
For example you might want to add a hint, that a certain resource or method need authorization, or you describe the special meaning of a field or resource...
In any case, I found it important that such documentation can be added to the code directly at the location of the data-model/schema-definition.
The proposed solution is a dict as described in the README of this request, which can be defined at any point in the code and loaded into the config before starting the eve-app. (In one project i used to define the dict directly in the SQLAlchemy-Model and was then loading the description together with the schema into the config. In small eve-projects, it can just be defined in the settings.py as shown in the example).
Important to notice: This additional description is non-mandatory, eve-docs keeps working as before. Just in case a developer wants to add a description this addition enables him/her to do so.
I added screenshots to the README and into the repository for a quick view on the example.
It seems to be useful to add a written description to the automatically generated documentation in some cases.
For example you might want to add a hint, that a certain resource or method need authorization, or you describe the special meaning of a field or resource... In any case, I found it important that such documentation can be added to the code directly at the location of the data-model/schema-definition. The proposed solution is a dict as described in the README of this request, which can be defined at any point in the code and loaded into the config before starting the eve-app. (In one project i used to define the dict directly in the SQLAlchemy-Model and was then loading the description together with the schema into the config. In small eve-projects, it can just be defined in the settings.py as shown in the example).
Important to notice: This additional description is non-mandatory, eve-docs keeps working as before. Just in case a developer wants to add a description this addition enables him/her to do so.
I added screenshots to the README and into the repository for a quick view on the example.