openapi: 3.1.0 info: title: ${SERVICE_NAME} API version: 1.0.0 description: API specification for ${SERVICE_NAME} contact: name: API Support email: support@example.com license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 servers: - url: http://localhost:8080 description: Local development server - url: https://api.example.com description: Production server tags: - name: health description: Health check endpoints paths: /actuator/health: get: tags: - health summary: Health check description: Returns the health status of the service operationId: healthCheck responses: '200': description: Service is healthy content: application/json: schema: $ref: '#/components/schemas/HealthResponse' components: schemas: HealthResponse: type: object properties: status: type: string enum: [UP, DOWN] description: Overall health status components: type: object additionalProperties: $ref: '#/components/schemas/ComponentHealth' required: - status ComponentHealth: type: object properties: status: type: string enum: [UP, DOWN] details: type: object additionalProperties: true Error: type: object properties: timestamp: type: string format: date-time description: When the error occurred status: type: integer description: HTTP status code error: type: string description: Error type message: type: string description: Error message path: type: string description: Request path traceId: type: string description: Trace ID for correlation required: - timestamp - status - message securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: JWT token authentication security: - bearerAuth: []