Module: health_response

Expand source code

# Copyright (C) 2023-present The Project Contributors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from __future__ import annotations
from pydantic import BaseModel
from cl.runtime.routers.user_request import UserRequest


class HealthResponse(BaseModel):
    """Response data type for the /health route."""

    status: int
    """HTTP status code."""

    @classmethod
    def get_health(cls, request: UserRequest) -> HealthResponse:
        """Implements /health route."""

        # TODO: Replace stub status code

        # Default response when running locally without authorization
        result_dict = {
            "status": 200,
        }

        return HealthResponse(**result_dict)

Classes

class HealthResponse (**data: Any)

Response data type for the /health route.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class HealthResponse(BaseModel):
    """Response data type for the /health route."""

    status: int
    """HTTP status code."""

    @classmethod
    def get_health(cls, request: UserRequest) -> HealthResponse:
        """Implements /health route."""

        # TODO: Replace stub status code

        # Default response when running locally without authorization
        result_dict = {
            "status": 200,
        }

        return HealthResponse(**result_dict)

Ancestors

pydantic.main.BaseModel

Class variables

var model_computed_fields
var model_config
var model_fields
var status: HTTP status code.

Static methods

def get_health(request: UserRequest) -> HealthResponse: Implements /health route.