mud_server.api.routes.health
============================

.. py:module:: mud_server.api.routes.health

.. autoapi-nested-parse::

   Health and root endpoints.

   Provides the root ``/`` endpoint (API identity and version) and the
   ``/health`` endpoint (liveness check with active session count).

   The version string is read from ``mud_server.__version__`` which is
   resolved at import time via ``importlib.metadata`` — the single source
   of truth is ``pyproject.toml``, bumped automatically by release-please.



Attributes
----------

.. autoapisummary::

   mud_server.api.routes.health.router


Functions
---------

.. autoapisummary::

   mud_server.api.routes.health.root
   mud_server.api.routes.health.health_check


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

.. py:data:: router

.. py:function:: root()
   :async:


   Root endpoint showing API identity and current version.

   Returns a JSON object with the API name and the version read from
   the installed package metadata (``pyproject.toml``).


.. py:function:: health_check()
   :async:


   Health check endpoint.