julee.api.responses
===================

.. py:module:: julee.api.responses

.. autoapi-nested-parse::

   Pydantic models for API responses.
   These define the contract between the API and external clients.

   Following clean architecture principles, most endpoints return domain models
   directly rather than creating wrapper response models. This file contains
   only response models that are specific to API concerns and not represented
   by existing domain models.



Classes
-------

.. autoapisummary::

   julee.api.responses.HealthCheckResponse
   julee.api.responses.ServiceHealthStatus
   julee.api.responses.ServiceStatus
   julee.api.responses.SystemStatus


Module Contents
---------------

.. py:class:: HealthCheckResponse(/, **data)

   Bases: :py:obj:`pydantic.BaseModel`


   Response for health check endpoint.


   .. py:attribute:: services
      :type:  ServiceHealthStatus


   .. py:attribute:: status
      :type:  SystemStatus


   .. py:attribute:: timestamp
      :type:  str


.. py:class:: ServiceHealthStatus(/, **data)

   Bases: :py:obj:`pydantic.BaseModel`


   Health status for individual services.


   .. py:attribute:: api
      :type:  ServiceStatus


   .. py:attribute:: storage
      :type:  ServiceStatus


   .. py:attribute:: temporal
      :type:  ServiceStatus


.. py:class:: ServiceStatus

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   Service status enumeration.


   .. py:attribute:: DOWN
      :value: 'down'



   .. py:attribute:: UP
      :value: 'up'



.. py:class:: SystemStatus

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   Overall system status enumeration.


   .. py:attribute:: DEGRADED
      :value: 'degraded'



   .. py:attribute:: HEALTHY
      :value: 'healthy'



   .. py:attribute:: UNHEALTHY
      :value: 'unhealthy'