magpie.api.swagger.views
========================

.. py:module:: magpie.api.swagger.views


Attributes
----------

.. autoapisummary::

   magpie.api.swagger.views.MAGPIE_MODULE_DIR


Functions
---------

.. autoapisummary::

   magpie.api.swagger.views.get_magpie_url
   magpie.api.swagger.views.api_swagger
   magpie.api.swagger.views.api_schema


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

.. py:data:: MAGPIE_MODULE_DIR

.. py:function:: get_magpie_url(container: Optional[magpie.typedefs.AnySettingsContainer] = None) -> magpie.typedefs.Str

   Obtains the configured Magpie URL entrypoint based on the various combinations of supported configuration settings.

   .. seealso::
       Documentation section :ref:`config_app_settings` for available setting combinations.

   :param container: container that provides access to application settings.
   :return: resolved Magpie URL


.. py:function:: api_swagger(request)

   Swagger UI route to display the Magpie REST API schemas.


.. py:function:: api_schema(request: pyramid.request.Request) -> magpie.typedefs.JSON

   Return JSON Swagger specifications of Magpie REST API.