Home
...
Portal Manager
API Catalog

API Catalog

Understand how to view, manage, and maintain API documentation in the API Catalog, including uploading, editing, deleting, and access permissions.

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

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 Catalog

Under the list of API Catalog 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 Catalog

NOTE
The action icons for editing () and deleting () are not available when the documentation has been automatically loaded with the API.

Search

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

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

Manual upload

To add documentation manually, follow the steps below:

Step 1

Under API Catalog, click the + NEW API Catalog button.

Step 2

On the next screen, click UPLOAD YOUR FILE, located towards the bottom left part of the screen.

Step 3

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.

Step 4

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

Viewing

To check your documentation, follow the steps below:

Step 1

Under API Catalog, click eye-shaped icon .

Step 2

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.

Editing a documentation

To change the documentation, follow the steps below:

Step 1

Under API Catalog, click pencil-shaped icon .

Step 2

On the next screen, click the REPLACE FILE button.

Step 3

Browse your file manager and select the desired .yaml or .json file. You may upload one file at a time.

Step 4

Click SAVE or SAVE AS NEW VERSION.

How happy are you with this page?

API Settings

Products - Portal Manager