Easily-Understandable Interface Descriptions
kmdn opened this issue · 0 comments
kmdn commented
[What]
Add easily-understandable interface descriptions for HTTP(S)-accessible protocols.
Mainly for (1) pipeline configuration and (2) pipeline components (MD, CG, ED, MD_CG, CG_ED, MD_CG_ED, Splitter, Combiner, Translator, Filter, Explainer, Evaluator, Recommender) with expected input and output.
[How]
OpenAPI [0] and Swagger [1]
[0] https://en.wikipedia.org/wiki/OpenAPI_Specification
[1] https://petstore.swagger.io/
[Why]
- Ease of execution for new and experienced users (-> lower required entry barrier)
- Ease of extension (through custom components)
- Simplified consistency checking in regards to defined protocols
- Ease of/Encouraging community support
- Simplify continuous API development