HealthCheckResponse
Health check response
Properties
| Property | Type | Required | Description |
|---|---|---|---|
status | string | ✅ Yes | - |
service | string | ✅ Yes | - |
backend_version | string | ❌ No | - |
dependencies | object | ❌ No | - |
timestamp | string | ✅ Yes | - |
Example
{
"status": "example",
"service": "example",
"backend_version": "example",
"dependencies": {},
"timestamp": "example"
}Used In
Code Examples
TypeScript
interface HealthCheckResponse {
status: string;
service: string;
backend_version?: string;
dependencies?: Record<string, any>;
timestamp: string;
}
// Usage example
const data: HealthCheckResponse = {
"status": "example",
"service": "example",
"backend_version": "example",
"dependencies": {},
"timestamp": "example"
};Python
from data_layer.schemas import HealthCheckResponse
# Create instance
data = HealthCheckResponse(
# Add your field values here
)cURL
curl -X POST "https://altsportsleagues-backend-2qcdjegnaa-uc.a.run.app/api/endpoint" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{ "status": "example", "service": "example", "backend_version": "example", "dependencies": {}, "timestamp": "example" }'Validation Rules
Required Fields: status, service, timestamp
Additional Information
- Type: object
- Source: Generated from Pydantic models in
data_layer/schemas/ - Auto-validated: All fields are validated by FastAPI
This documentation is auto-generated from the OpenAPI specification.