incubator-devlake
incubator-devlake copied to clipboard
[Doc][plugin api] Add swagger documentation for all plugin APIs
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
- #2450
- Update website doc according to #2450
- #2668
- Update website doc according to #2668
- swagger support for Github plugin #2697
- swagger support for Gitlab plugin #2698
- #2699
- Update website doc according to #2699
- #2701
- Update website doc according to #2701
- DBT
- Feishu #2707
- Gitee #2714
- GitExtractor
- Refdiff
- Add prefix
framework/to all framework api (modification is part of #2709) - Add response body for all plugins response #2709
- Update
POST /blueprints: tells the overall structure of thesettingsfield, and where to look for plugin-specific structure. or we can go - Add
POST /plugins/<PLUGIN_NAME/blueprint-planto describe plugin-specific structure #2734 - Update
POST /pipelines: same thing toPOST /blueprints#2735 - Add
POST /plugins/<PLUGIN_NAME/pipeline-verifyto verify the pipeline options for the plugin