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