api reference

The project consists of a REST API Client Abstract Base Class called RestApiBaseClass and a number of vendor- and product-specific implementations listed in the navigation. There are a few helper classes that are instantiated as part of the client as well. They can be found in the exceptions and scheduling modules. The scheduling module is used to manage concurrency, while the exceptions module contains custom exceptions that are raised by the client when errors occur.

Each section in the API reference corresponds to a different module in the code base. Each of the client implementations are documented in their own dedicated sections. You can navigate through the sections using the sidebar on the left (or burger-menu depending on your screen-size and resolution).

The API sections are mostly generated from the codebase, using MkDocs and the mkdocstrings plugin - theme is Material for MkDocs. We rely heavily on type hints and very verbose docstrings with strict formatting to generate the documentation.