API Docs

The documentation concerning your APIs that is exhibited in Products is also listed here in API Docs.

Documentation is automatically loaded when your API is imported, but it is also possible to add it manually.

You may also edit and delete (only documentation that has been added manually) and visualize it.

List of API Docs

Under the list of API Docs you will find the following columns:

Vendor: indicated by the icons: (Sensedia) and (AWS);
API Name: the same name as registered on your API Platform;
Version: API version;
Last revision: "rev" number;
Availability: informs whether the API is available for display and to be used by an APP;
Actions: you can edit, delete and view the documentation by clicking on the respective icon.

screenshot from api docs

The action icons for editing (

) and deleting (

) are not available when the documentation has been automatically loaded with the API.

The search field is located just above the list of API Docs.

You can search the documentation by API name and sort the result in ascending or descending order.

To add documentation manually, follow the steps below:

Under API Docs, click the + NEW API DOCS button.
On the next screen, click UPLOAD YOUR FILE, located towards the bottom left part of the screen.
Browse your files using the file manager from your operational system and select the desired .yaml or .json file.
You may upload one file at a time.
The selected file will be displayed on the screen. Click SAVE or REPLACE FILE to choose a different file.

steps to add new documentation manually

To check your documentation, follow the steps below:

Under API Docs, click .
The next screen will display the latest version of that Swagger or OpenAPI. If more than one version is available, they will be listed at the top of the screen. Select the version you want to view.

As a result of these steps, the documentation will be loaded and displayed on the screen.

To change the documentation, follow the steps below:

Under API Docs, click .
On the next screen, click the REPLACE FILE button.
Browse your file manager and select the desired .yaml or .json file.
You may upload one file at a time.
Click SAVE or SAVE AS NEW VERSION.

Thanks for your feedback!

EDIT