kmdn / kmdn/combining-linking-techniques
Easily-Understandable Interface Descriptions
- Dominant language
- Python
- Stars
- 8
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
[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]
1. Ease of execution for new and experienced users (-> lower required entry barrier)
2. Ease of extension (through custom components)
3. Simplified consistency checking in regards to defined protocols
4. Ease of/Encouraging community support
5. Simplify continuous API development
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.