OpenAPI 3.0 Documentation using springdoc
Link to ADR(Architecture Decision Record) : Swagger using springdoc-openapi
OpenAPI 3.0 related changes
- upgraded to latest springdoc openapi latest version 1.7.0
- Documented the below API's with OpenAPI 3.0 Annotations
- WorkflowManager API
- WorkflowRun API
- WorkflowSystemManager API
- HealthCheck API
- Info API
- Added the standard HTTP Response(4xx, 5x****x) for API Responses
- Custom Path for
- Swagger UI: https://host/context-path/swagger (will redirect to https://host/context-path/swagger-ui/index.html)
- api-docs (JSON) : https://host/context-path/api-docs
- api-docs (YAML) : https://host/context-path/api-docs.yaml
- Azure Swagger GLAB(for Reference)
- Swagger UI: https://osdu-glab.msft-osdu-test.org/api/workflow/swagger (will redirect to https://osdu-glab.msft-osdu-test.org/api/workflow/swagger-ui/index.html)
- api-docs (JSON) : https://osdu-glab.msft-osdu-test.org/api/workflow/api-docs
- api-docs (YAML) :https://osdu-glab.msft-osdu-test.org/api/workflow/api-docs.yaml
- Marked the below Internal API's as Hidden
- Azure WhoamiController
- Azure CustomOperatorApi
Other Changes
- Configurable descriptions managed in swagger.properties
- Deleted [HomeController, HomeControllerTest, SpringfoxSwaggerHostResolver, SpringfoxSwaggerHostResolverTest, SwaggerDocumentationConfig]
- Updated Readme for swagger related information