Item Details in the Catalog
To view the details of an API, access the Discovery screen and click on the icon , in the catalog item listing.
You can check general information about the API, as well as its revisions and associated environments.
Here are the panels:
-
-
Consistency: Quality Analysis and
-
Efficiency: Redundancy Detector
-
(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 (user or team responsible for the API);
-
Edit Shared with (users or teams with whom the API is shared);
(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.
Share your suggestions with us!
Click here and then [+ Submit idea]