Item Details in the Catalog

View the details of an API by accessing the Discovery screen.
To do this, click on the icon icon visualize, in the catalog item listing.
highlighting the icon to access the details screen

You can check general information about the API, as well as its revisions and associated environments.

Here are the panels:

panels that make up the details screen

(A) Basic info

This panel contains the following information about the API:

  • The name, which appears as the panel title;

  • Description: description;

  • Created At: creation date and time;

  • Imported At: import date and time;

  • Updated At: update date and time;

  • Version: most recent version;

  • Owner: responsible user or team;

  • Shared with: users with whom the API is shared;

  • Tags: associated tags (or labels).

From the Basic info panel, you can perform the following actions:

Change the Owner

  1. Owner: to edit who is responsible (user or team) for the API, click on image representing a person (next to Owner) and select the desired option.

  2. Click SAVE

screen to change the API owner


Edit Shared with

  1. To edit with whom the API is shared, click on image representing two people (next to Shared with) and select one or more users or teams.

  2. Click SAVE

screen to change the users the API is shared with


Add or Remove Tags

To add a tag:

  1. Click on the icon icon tags to add a tag.

  2. In the Tag Name field, type the name of the tag you want to associate (new or previously registered).

    • A tag name must contain at least 2 and at most 30 characters.

    • Only lowercase alphanumeric characters and "-" are accepted.

    • The tag name cannot start or end with "-".

  3. Click + (or press ENTER on your keyboard) to associate the tag.

  4. If you want to add another tag, repeat the last two steps. Each API can have up to 50 tags associated.

  5. Click OK to close the window.

    tag screen with emphasis on the + to add

    If you click OK without clicking + (or pressing enter), the tag will not be associated/created.

To remove a tag:

  1. Click on the icon icon tags to add a tag.

  2. In the window that opens, locate the tag you want to unlink from the API.

  3. Click the X button of that tag to remove it.

    tag screen with emphasis on the x to remove

  4. If you want to remove another tag from this API, repeat the last two steps.

  5. Click OK to close the window.

(B) REVISIONS Tab

In this tab, you find the revision history of the API.

Columns in the revisions list:

(C) DEPLOYMENTS Tab

In this tab, you find information about the deployment environments of the APIs.

Columns in the deployments list:

  • SERVER NAME: server name;

  • SERVER URL: server address;

  • DEPLOYED REVISION: number or date of the revision deployed on the server.

    When no revision of the API exists, a dash ("-") will be displayed in this column and in the maturity column.

  • MATURITY: maturity score;

  • ACTIONS: access to Maturity Report and API Specification.

(D) ISSUES Panel and Quality Analysis

Issues

This panel displays issues that may impact the quality of the APIs and their ecosystem.

Elements that can be adjusted to improve aspects such as organization and performance will be highlighted and listed in this space.

Most common types of Issues:

  • Consistency: related to the consistency and organization of the APIs. It indicates violations of good practices in OpenAPI contracts. It checks whether contracts are complete and consistent, ensuring that development and documentation are aligned with the organization’s rules.

  • Efficiency: related to resource usage. It indicates redundancies and optimization opportunities. It does not cover performance-related aspects.

    An empty field in the ISSUES column right after import does not necessarily indicate the absence of problems.
    After import, APIs need to be processed, and the time to generate the Issues may range from minutes to several hours, depending on the number of APIs and the size of the imported contracts.

Quality Analysis

This panel displays the API’s maturity score.

Click Go to issues details to see the Maturity Report and API Specification and to access Smart Recommendations.

Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]