:py:mod:`src.ska_src_api_accounting.models`
===========================================

.. py:module:: src.ska_src_api_accounting.models

.. autoapi-nested-parse::

   Response models import.



Submodules
----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   compute/index.rst
   nodes/index.rst
   response/index.rst
   storage/index.rst


Package Contents
----------------

Classes
~~~~~~~

.. autoapisummary::

   src.ska_src_api_accounting.models.GenericErrorResponse
   src.ska_src_api_accounting.models.GenericOperationResponse
   src.ska_src_api_accounting.models.HealthResponse
   src.ska_src_api_accounting.models.PingResponse




.. py:class:: GenericErrorResponse


   Bases: :py:obj:`Response`

   The generic error response model.

   .. py:attribute:: detail
      :type: str

      


.. py:class:: GenericOperationResponse


   Bases: :py:obj:`Response`

   The generic operation error response model.

   .. py:attribute:: successful
      :type: bool

      


.. py:class:: HealthResponse


   Bases: :py:obj:`Response`

   The health endpoint response model.

   .. py:class:: DependentServices


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

      The dependent services response model.

      .. py:class:: DependentServiceStatus


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

         The dependent services state response model.

         .. py:attribute:: status
            :type: Literal[UP, DOWN]

            


      .. py:attribute:: permissions_api
         :type: HealthResponse.DependentServices.DependentServiceStatus

         


   .. py:attribute:: dependent_services
      :type: HealthResponse.DependentServices

      

   .. py:attribute:: number_of_managed_requests
      :type: pydantic.NonNegativeInt

      

   .. py:attribute:: uptime
      :type: pydantic.NonNegativeInt

      


.. py:class:: PingResponse


   Bases: :py:obj:`Response`

   The ping endpoint response model.

   .. py:attribute:: status
      :type: Literal[UP, DOWN]

      

   .. py:attribute:: version
      :type: str