leaf_engine.io.api.crud_openapi
===============================

.. py:module:: leaf_engine.io.api.crud_openapi


Attributes
----------

.. autoapisummary::

   leaf_engine.io.api.crud_openapi.OPENAPI_ENDPOINT
   leaf_engine.io.api.crud_openapi.OPENAPI_TOKEN
   leaf_engine.io.api.crud_openapi.schemas


Functions
---------

.. autoapisummary::

   leaf_engine.io.api.crud_openapi._get_api_schemas
   leaf_engine.io.api.crud_openapi._validate
   leaf_engine.io.api.crud_openapi.get_columns
   leaf_engine.io.api.crud_openapi.validate_network_move
   leaf_engine.io.api.crud_openapi.validate_raw_insert


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

.. py:function:: _get_api_schemas() -> dict

   Gets CRUD API schema.


.. py:function:: _validate(record: Mapping[str, Any], schema: Mapping[str, Any]) -> None

   Validates record against schema.

   :raises ValidationError: Raises when record is invalid.

   :param record: Record to validate.
   :type record: Mapping[str, Any]
   :param schema: OpenAPI/Swagger 2.0 json schema.
   :type schema: Mapping[str, Any]


.. py:function:: get_columns(table_name: str) -> Mapping[str, Any]

   Returns a mapping of column names and data types for a given table. Returns
   all properties defined, and does not distinguish between required or not.

   :param table_name: (str): Name of database table


.. py:function:: validate_network_move(record: Mapping[str, Any]) -> None

   Validates network move record.

   :raises ValidationError: Raises when record is invalid.

   :param record: Network move record.
   :type record: Mapping[str, Any]


.. py:function:: validate_raw_insert(record: Mapping[str, Any], table_name: str) -> None

   Validates raw shipment or raw lane record.

   :raises ValidationError: Raises when record is invalid.

   :param record: Raw db record.
   :type record: Mapping[str, Any]


.. py:data:: OPENAPI_ENDPOINT

.. py:data:: OPENAPI_TOKEN

.. py:data:: schemas