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 below API's with OpenAPI 3.0 Annotations

  1. ActivityPlanApi
  2. BHARunApi
  3. EntityApi
  4. FluidsProgramApi
  5. FluidsReportApi
  6. HoleSectionApi
  7. OperationsReportApi
  8. QueryApi
  9. WellActivityProgramApi
  10. WellApi
  11. WellboreApi
  12. WellboreTrajectoryApi
  13. HealthCheckApi
  14. InfoApi

• 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/well-delivery/swagger (will redirect to https://osdu-glab.msft-osdu-test.org/api/well-delivery/swagger-ui/index.html)
  • api-docs (JSON) : https://osdu-glab.msft-osdu-test.org/api/well-delivery/api-docs
  • api-docs (YAML) : https://osdu-glab.msft-osdu-test.org/api/well-delivery/api-docs.yaml

Other Changes

• Configurable descriptions managed in swagger.properties

• Deleted HomeController and SwaggerDocument‎ationConfig

• Updated Readme for swagger related information