Skip to main content

13.3 Technical documentation for OLIVE

Technical Documentation​

The OLIVE technical documentation entry page can be found at:

https://app.<tenant>.<cluster>.<domain>/?config=olive-docs

The version of these generated documentation artifacts matches exactly what is used in your deployed OLIVE platform version.

API Documentation​

This includes the documentation of the public HTTP APIs of OLIVE. The APIs are documented using OpenAPI version 3.0.

You can use the Try it out button to invoke OLIVE's public APIs directly from the documentation page.

Type Documentation​

The type documentation contains all OLIVE types that can be created in the connectivity editor. The documentation is generated using TypeDoc.

Note that all elements creatable in the OLIVE connectivity editor that are not part of this documentation are not stable types, and their usage might not be fully supported.