Item Details in the Catalog

To view the details of an API, access the Discovery screen and 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) Overview Tab

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;

  • Owner: responsible user or team;

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

  • Tags: associated tags (or labels).

From the Overview 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) ISSUES Panel powered by AI

In the Issues panel, you can view the problems detected by AI that may impact the quality of your APIs and the ecosystem. These are elements that can be adjusted to improve aspects such as organization and performance.

  • CONSISTENCY: Quality Analysis: related to the consistency and organization of APIs. It indicates the presence of best practice violations in OpenAPI contracts. It checks whether contracts are complete and consistent, ensuring that development and documentation are aligned with your organization’s rules.

    The chart represents the API’s maturity level.
    Click Go to issue details to view the full Maturity Report and access the Smart Recommendations.

  • EFFICIENCY: Redundancy Detector: related to resource usage. It highlights redundancies and optimization opportunities. It does not cover performance-related aspects.

    The number shown indicates how many redundant resources were found.
    Click Go to issue details to see the full list of redundancies.

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

(C) DOCUMENTATION Tab

In this tab, you will find the Maturity Report, API specification and the access button for the Smart Recommendations.

(D) DEPLOYMENTS Tab

In this tab, you will find information about the environments where the API is deployed.

Each card displays the following information:

  • Environment name;

  • Address;

  • Revision number. Click to view the specification, maturity report, and the access button for the Smart Recommendations.

Thanks for your feedback!
EDIT

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