.. _esrfpath-api:

Reference
=========

The :class:`ESRFPath` class by default is equivalent to ESRF schema v3 with fallback to v2

.. code-block:: python

    class ESRFPath(ESRFPath, esrf=3, fallback_depth=1):
        pass

Other schemas can be selected (``None`` denotes the latest version of a schema)

.. code-block:: python

    class TomoPath(ESRFPath, tomo=None, fallback_depth=0):
        pass

Schemas can be mixed provided they do not have conflicting fields or extend different
versions of the same base schema

.. code-block:: python

    class MyPath(ESRFPath, schemaA=1, schemaB=2, fallback_depth=0):
        pass

.. toctree::
    :maxdepth: 2

    reference/public_api
    reference/private_api