cowbird.api.swagger
===================

.. py:module:: cowbird.api.swagger


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/cowbird/api/swagger/views/index


Functions
---------

.. autoapisummary::

   cowbird.api.swagger.api_schema
   cowbird.api.swagger.api_swagger
   cowbird.api.swagger.get_logger
   cowbird.api.swagger.includeme


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

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

   Return JSON Swagger specifications of Cowbird REST API.


.. py:function:: api_swagger(request: pyramid.request.Request) -> cowbird.typedefs.JSON

   Swagger UI route to display the Cowbird REST API schemas.


.. py:function:: get_logger(name: str, level: Optional[int] = None, force_stdout: bool = None, message_format: Optional[str] = None, datetime_format: Optional[str] = None) -> logging.Logger

   Immediately sets the logger level to avoid duplicate log outputs from the `root logger` and `this logger` when
   `level` is ``logging.NOTSET``.


.. py:function:: includeme(config: pyramid.config.Configurator) -> None