Anand Mazumdar created MESOS-5791:
-------------------------------------
Summary: Consider adding support for a API documentation tool.
Key: MESOS-5791
URL: https://issues.apache.org/jira/browse/MESOS-5791
Project: Mesos
Issue Type: Improvement
Reporter: Anand Mazumdar
Currently, the Scheduler/Executor API docs are generated via markdown. This is
albeit hard to maintain and adding complete/custom JSON snippets is very
cumbersome.
We should consider adding support for generating API documentation via an
automated tool like Swagger etc. The only catch is that all our API's are RPC
based and hence would be good to explore tools that fit that criteria.
This ticket is around exploring possible tooling choices.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
