Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Easily-Understandable Interface Descriptions #2

Open
kmdn opened this issue Jan 27, 2022 · 0 comments
Open

Easily-Understandable Interface Descriptions #2

kmdn opened this issue Jan 27, 2022 · 0 comments
Assignees
@kmdn
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@kmdn
Copy link
Owner

kmdn commented Jan 27, 2022

[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
@kmdn kmdn added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 27, 2022
@kmdn kmdn self-assigned this Jan 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kmdn kmdn

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@kmdn