Generate Swagger using springdoc-openapi

Type of change

• Bug Fix
• Feature

Link to ADR(Architecture Decision Record) : Swagger using springdoc-openapi

OpenAPI 3.0 related changes

• upgraded to latest springdoc openapi latest version 1.6.14
• used @OpenAPIDefinition annotation to populate OpenAPI Object fields [info, tags, servers, security]
• Documented Query, Record, Patch , Info & Health API with OpenAPI 3.0 Annotations
• 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

Other Changes

• Configurable descriptions managed in swagger.properties
• added Integration Test cases for Swagger-UI, api-docs endpoints
• Hide deprecated [Schema, PubSubEndpoints] related API operations in documentation
• Deleted HomeController

References

• https://springdoc.org/faq.html#_can_i_use_spring_property_with_swagger_annotations
• https://springdoc.org/migrating-from-springfox.html

changed milestone to %M16 - Release 0.19

added Common Code label

assigned to @thulasi_dass

added MREnhancement label

changed title from Draft: Generate Swagger using springdoc-openapi OAS3.0 to Draft: Generate Swagger using springdoc-openapi

added 6 commits

• 2cd6785e...cfbf713d - 5 commits from branch master
• 66b135a6 - Merge branch 'master' into az/td-oas

Compare with previous version

added 4 commits

• 66b135a6...1bc9698b - 2 commits from branch master
• 00b9104f - Merge branch 'master' into az/td-oas
• 4fb19a4a - Turn off Collaboration context featureflag

Compare with previous version

mentioned in merge request !610 (closed)

marked this merge request as ready

mentioned in merge request !626 (merged)

added 11 commits

• 4fb19a4a...a79174f0 - 9 commits from branch master
• c4399e8e - Merge branch 'master' into az/td-oas
• f49cc9ae - Add Collaboration Filter excluded paths

Compare with previous version

approved this merge request

Hello @chad Latest pipeline is passed https://community.opengroup.org/osdu/platform/system/storage/-/pipelines/167597

cc: @Srinivasan_Narayanan @nursheikh

approved this merge request

Approvals are already obtained here !610 (closed) . Pipelines are passing. Please proceed to merge.

mentioned in commit c8ad6ab4

merged

mentioned in merge request !628 (merged)

mentioned in merge request osdu/platform/deployment-and-operations/helm-charts-azure!544 (merged)

mentioned in issue #160

mentioned in merge request !639 (merged)