bbotella opened a new pull request, #239: URL: https://github.com/apache/cassandra-sidecar/pull/239
CASSSIDECAR-176 This patch enhances the OpenAPI documentation for the Cassandra Sidecar by adding comprehensive annotations with examples and schema references. Key changes: - Added OpenAPI dependencies and Gradle configuration - Created OpenAPI configuration classes and module system - Implemented OpenAPI documentation generator with HTML output - Added custom OpenAPI annotations (@OpenApiEndpoint, @OpenApiResponse) - Enhanced VertxRouteMapKeys with comprehensive OpenAPI annotations - Added examples for all 60+ API endpoints to improve documentation readability - Fixed schema reference issues where examples were not rendering in HTML - Added comprehensive schema definitions for all response types - Included proper error response examples for health check endpoints - Created OpenAPI web handlers for Swagger UI and documentation serving - Added comprehensive test suite to validate OpenAPI annotation completeness - Updated configuration to include OpenAPI settings - Added OpenAPI documentation guide (OPENAPI.md) The changes ensure that all API endpoints have proper OpenAPI documentation with examples and schema references, making the API documentation more comprehensive and user-friendly. The implementation includes a complete web interface for viewing and interacting with the API documentation. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: pr-unsubscr...@cassandra.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: pr-unsubscr...@cassandra.apache.org For additional commands, e-mail: pr-h...@cassandra.apache.org
