.. _functions:

Functions
=========

goslin_rest : Configuration of the API
--------------------------------------
.. automodule:: main.goslin_rest

Creation of the local database
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autofunction:: main.goslin_rest.create_local_database

See the :func:`main.goslin_fct.parse_sdf` for more detail.

Instantiation of the API
^^^^^^^^^^^^^^^^^^^^^^^^
.. autofunction:: main.goslin_rest.create

See the :ref:`Swagger documentation <doc_swagger>` for more information on the endpoints.
See :func:`main.goslin_fct.get_version_metadata` for more details about the metadata.


Setting the arguments
^^^^^^^^^^^^^^^^^^^^^
.. autofunction:: main.goslin_rest.arguments
.. autofunction:: main.goslin_rest.valid_port
.. autofunction:: main.goslin_rest.create_parser_args


goslin_fct : Core functions of the API
--------------------------------------
.. automodule:: main.goslin_fct
    :members: