Documentation Scope
Thanks to the contribution of #1900 from @xgdyp , we had swagger documentation support a long time ago. Which display our Framework APIs for developers, and they could test out the APIs easily on the swagger page.
However, the plugin APIs documentation is still missing.
Describe the Change
Add swagger comment to all our plugins.
Plan of attacks
Documentation Scope
Thanks to the contribution of #1900 from @xgdyp , we had swagger documentation support a long time ago. Which display our Framework APIs for developers, and they could test out the APIs easily on the swagger page.
However, the plugin APIs documentation is still missing.
Describe the Change
Add
swaggercomment to all our plugins.Plan of attacks
framework/to all framework api (modification is part of [Bug][Plugins] Missing response body in swagger #2709)POST /blueprints: tells the overall structure of thesettingsfield, and where to look for plugin-specific structure. or we can goPOST /plugins/<PLUGIN_NAME/blueprint-planto describe plugin-specific structure [Feature][Plugins] Add fake blueprint api with swagger to describe plugin structure #2734POST /pipelines: same thing toPOST /blueprints[Feature][Plugins] add fake pipeline api with swagger for all plugins #2735POST /plugins/<PLUGIN_NAME/pipeline-verifyto verify the pipeline options for the plugin [Feature][Framework] Add api to verify the pipeline options for the plugin #2767