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.6.14
• used @OpenAPIDefinition annotation to populate OpenAPI Object fields [info, tags, servers, security]
• Documented the below API's with OpenAPI 3.0 Annotations
  • CleanupIndicies API
  • PartitionSetup API
  • Reindex API
  • RecordIndexer API(Internal API, marked as 'Hidden' for documentation)
  • Health Check 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/indexer/v2/swagger (will redirect to https://osdu-glab.msft-osdu-test.org/api/indexer/v2/swagger-ui/index.html)
• api-docs (JSON) : https://osdu-glab.msft-osdu-test.org/api/indexer/v2/api-docs
• api-docs (YAML) :https://osdu-glab.msft-osdu-test.org/api/indexer/v2/api-docs.yaml

Other Changes

• Configurable descriptions managed in swagger.properties
• Deleted HomeController
• Marked the 'WhoamiController' as 'Hidden' for documentation
• Updated Readme for swagger related information

References

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

changed milestone to %M18 - Release 0.21

added Common Code MREnhancement labels

assigned to @thulasi_dass

marked this merge request as draft

marked this merge request as ready

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

Hello Team @nursheikh @Rustam_Lotsmanenko @andrei_dalhikh @fhoueto.amz @BdasIBM @nthakur Kindly review & approve the OpenAPI 3.0 Swagger MR.

cc: @chad @Srinivasan_Narayanan

approved this merge request

approved this merge request

approved this merge request

added 5 commits

• 560cfc0c...24917927 - 3 commits from branch master
• 25a6c757 - address review comments
• 377fa2c1 - Merge branch 'master' into az/td-oas

Compare with previous version

resolved all threads

• Review comments addressed and latest pipeline is passed

approved this merge request

mentioned in commit 986f857c

merged