Library for easier use of Airlock's REST API.
This library is not part of the official Airlock product delivery and Ergon/Airlock does not provide support for it. Best effort support may be provided by the contributor of the library.
The current version of this library has been developed for hosts running Airlock Gateway 8.2, some REST calls will not work for hosts running different versions of Airlock Gateway.
A full documentation of this library is available at Airlock's GitHub Page.
An example script is provided under the examples folder with
the intent to demonstrate how to use some of the library functions.
This library uses the requests library to perform standard HTTP requests
to Airlock Gateway REST endpoints.
404 response status codes are handled by the library, i.e. if a provided ID
or REST endpoint cannot be found, no exceptions will be raised.
For all other unexpected response status codes, e.g. malformed data is used to
generate a new mapping, a custom Exception named AirlockGatewayRestError is
raised.
In addition to that, any Exception raised by the requests library is not
handled by this library, so for example if network problems occur,
multiple Errors will be raised by the underlying library.