pipeworks_mud_mapper.services.api_db_service
============================================

.. py:module:: pipeworks_mud_mapper.services.api_db_service

.. autoapi-nested-parse::

   SQLite storage for remote API services and commands.

   This module manages a separate SQLite database used to store remote API
   service definitions and reusable commands that can be executed from the UI.



Functions
---------

.. autoapisummary::

   pipeworks_mud_mapper.services.api_db_service.list_services
   pipeworks_mud_mapper.services.api_db_service.get_service
   pipeworks_mud_mapper.services.api_db_service.create_service
   pipeworks_mud_mapper.services.api_db_service.update_service
   pipeworks_mud_mapper.services.api_db_service.delete_service
   pipeworks_mud_mapper.services.api_db_service.list_commands
   pipeworks_mud_mapper.services.api_db_service.get_command
   pipeworks_mud_mapper.services.api_db_service.create_command
   pipeworks_mud_mapper.services.api_db_service.update_command
   pipeworks_mud_mapper.services.api_db_service.delete_command


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

.. py:function:: list_services(db_path = None, *, include_disabled = True)

   Return API services.


.. py:function:: get_service(service_id, db_path = None)

   Return a single API service.


.. py:function:: create_service(name, base_url, *, auth_type = 'none', auth_secret = None, default_headers = None, enabled = True, notes = None, db_path = None)

   Create a new API service and return its ID.


.. py:function:: update_service(service_id, *, name, base_url, auth_type = 'none', auth_secret = None, default_headers = None, enabled = True, notes = None, db_path = None)

   Update an existing API service.


.. py:function:: delete_service(service_id, db_path = None)

   Delete an API service and cascade its commands.


.. py:function:: list_commands(service_id = None, db_path = None)

   Return commands for a service (or all commands when service_id is None).


.. py:function:: get_command(command_id, db_path = None)

   Return a single command.


.. py:function:: create_command(service_id, name, method, path, *, query = None, headers = None, body = None, timeout_seconds = None, db_path = None)

   Create a new API command and return its ID.


.. py:function:: update_command(command_id, *, service_id, name, method, path, query = None, headers = None, body = None, timeout_seconds = None, db_path = None)

   Update an existing API command.


.. py:function:: delete_command(command_id, db_path = None)

   Delete a command.