Generate documentation based on Python code instead of manually generated yaml

Description

Actual

Currently, we generate API documentation manually via api.yml file in wazo_confd. As of today existing documentation is incomplete, maintaining and completing it is a tiedous work to do and error prone.

Expectation

Generate documentation automatically based on python, e.g. schema.py, in order to always have an up-to-date documentation and make it a reliable source of information

see: marshmallow-code/apispec

 

Zendesk Ticket IDs

None

Activity

Show:
Duplicate

Details

Priority

Assignee

Reporter

Zendesk Support

Created July 23, 2019 at 1:27 PM
Updated February 13, 2024 at 1:26 PM
Resolved February 13, 2024 at 1:26 PM