.. Omni-Connector docs documentation master file, created by
   sphinx-quickstart on Fri May 19 08:51:18 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Omni-Connector documentation!
========================================

Here you can find all about MINT Omni-Connector, including `API specification`_, live
API examples (both MINT and Partner-Platform) powered by swagger.

These examples made to demonstrate perfect API for us to integrate with. It strongly
resembles our domain model and aligns perfectly with our flow. We are also expect that
Platform would implement OAUTH 2.0 for authentication and authorization.

We expect, that Platform would implement its own API according to that specification,
so we could integrate with it seamlessly.

.. _API specification: /api/redoc

What is Omni-Connector?
-----------------------

Omni-Connector is a microservice at MINT cluster, which sole purpose is to support
integration with numerous PlatformEnum that support common interface.

Also, Omni-Connector supports Platform-specific adapters that share common interface
and allow for handling some platform-specific logic, preventing it from leaking into
our business logic.

Contents
========

.. toctree::
   :maxdepth: 2
   :glob:

   *