src.app
=======

.. py:module:: src.app

.. autoapi-nested-parse::

   The main web application that serves the Digital Twin to the web through a Rest API.



Attributes
----------

.. autoapisummary::

   src.app.app
   src.app.SWAGGER_URL
   src.app.API_URL
   src.app.swagger_ui_blueprint
   src.app.gunicorn_logger


Functions
---------

.. autoapisummary::

   src.app.index
   src.app.health_check


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

.. py:data:: app

.. py:data:: SWAGGER_URL
   :value: '/swagger'


.. py:data:: API_URL
   :value: '/static/api_documentation.yml'


.. py:data:: swagger_ui_blueprint

.. py:function:: index() -> flask.Response

   Ping this endpoint to check that the flask app is running.
   Supported methods: GET

   :returns: The HTTP Response. Expect OK if health check is successful
   :rtype: Response


.. py:function:: health_check() -> flask.Response

   Ping this endpoint to check that the server is up and running.
   Supported methods: GET

   :returns: The HTTP Response. Expect OK if health check is successful
   :rtype: Response


.. py:data:: gunicorn_logger