Merge pull request #35 from community-of-python/exclude-health-from-openapi-schema

Exclude `/health` route from OpenAPI schema by default, and allow to configure it

Author: vrslev

README.md

@@ -422,6 +422,7 @@ class YourSettings(BaseServiceSettings):
 
     health_checks_enabled: bool = True
     health_checks_path: str = "/health/"
+    health_checks_include_in_schema: bool = False
 ```
 
 Parameter descriptions:
@@ -430,6 +431,7 @@ Parameter descriptions:
 - `service_version` - Will be displayed in health check response.
 - `health_checks_enabled` - Must be True to enable health checks.
 - `health_checks_path` - Path for health check handler.
+- `health_checks_include_in_schema` - Must be True to include `health_checks_path` (`/health/`) in OpenAPI schema.
 
 ## Configuration
 
@@ -558,7 +560,7 @@ application: litestar.Litestar = (
 ## Advanced
 
 If you miss some instrument, you can add your own.
-Essentialy, `Instrument` is just a class with some abstractmethods.
+Essentially, `Instrument` is just a class with some abstractmethods.
 Every instrument uses some config, so that's first thing, you have to define.
 
 ```python

microbootstrap/bootstrappers/fastapi.py

@@ -122,6 +122,10 @@ def get_config_type(cls) -> type[FastApiPrometheusConfig]:
 class FastApiHealthChecksInstrument(HealthChecksInstrument):
     def bootstrap_after(self, application: fastapi.FastAPI) -> fastapi.FastAPI:
         application.include_router(
-            build_fastapi_health_check_router(self.health_check, self.instrument_config.health_checks_path),
+            build_fastapi_health_check_router(
+                health_check=self.health_check,
+                health_check_endpoint=self.instrument_config.health_checks_path,
+                include_in_schema=self.instrument_config.health_checks_include_in_schema,
+            ),
         )
         return application

microbootstrap/bootstrappers/litestar.py

@@ -147,8 +147,9 @@ def bootstrap_before(self) -> dict[str, typing.Any]:
         return {
             "route_handlers": [
                 build_litestar_health_check_router(
-                    self.health_check,
-                    self.instrument_config.health_checks_path,
+                    health_check=self.health_check,
+                    health_check_endpoint=self.instrument_config.health_checks_path,
+                    include_in_schema=self.instrument_config.health_checks_include_in_schema,
                 ),
             ],
         }

microbootstrap/instruments/health_checks_instrument.py

@@ -11,6 +11,7 @@ class HealthChecksConfig(BaseInstrumentConfig):
 
     health_checks_enabled: bool = True
     health_checks_path: str = "/health/"
+    health_checks_include_in_schema: bool = False
 
 
 class HealthChecksInstrument(Instrument[HealthChecksConfig]):

poetry.lock

@@ -66,7 +66,7 @@ fastapi = { version = "^0.111.0", optional = true }
 prometheus-fastapi-instrumentator = { version = "^6.1.0", optional = true }
 opentelemetry-instrumentation-fastapi = { version = "^0.46b0", optional = true }
 fastapi-offline-docs = { version = "^1.0.1", optional = true }
-health-checks = "^1.0.0"
+health-checks = "^1.1.0"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^8.2.2"