Skip to content

Add 'Utilities' section to OpenAPI documentation configuration file to categorize API endpoints for fetching information

Insidious Fiddler requested to merge feature/API-Health-Check into main

This pull request introduces the addition of a 'Utilities' section in the OpenAPI documentation configuration file. The purpose of this section is to categorize API endpoints related to fetching information about the API. Additionally, the pull request includes several new features. First, a health check endpoint is added to the API v1 routes. This endpoint is handled by the HealthCheckController, which is also introduced in this pull request. Moreover, the ErrorResponse and SuccessResponse classes are included to generate OpenAPI response schema for health check error and success responses. These changes aim to improve the organization and categorization of API endpoints, as well as provide a health check functionality to ensure the API's proper functioning.

Merge request reports