Descriptions for API Collections & Endpoints
Last updated
Was this helpful?
Last updated
Was this helpful?
Adding descriptions to your API collections and endpoints in Akto helps keep your API inventory well-organized and easier to understand for all team members. It’s especially useful for documentation, collaboration, and tracking purposes.
Navigate to API Discovery:
On the left sidebar, click on API Discovery.
Select the API Collection:
Choose your desired API collection from the list.
Add or Edit the Description:
Click Add a brief description (located at the top of the collection view).
Enter your description (up to 64 characters).
Click anywhere outside the input box or press Enter to save.
View the API Collection:
Go to the API Discovery section and select your API collection.
Select the Endpoint:
Click on the endpoint you want to describe.
Add/Edit the Endpoint Description:
In the right panel that opens, you'll see a field under the endpoint path.
Click to edit and enter a description (up to 64 characters).
Your changes will save automatically or when you click outside the input box.
Improve clarity: Helps team members understand the purpose of APIs quickly.
Better documentation: Keeps your API inventory up-to-date with meaningful notes.
Ease of collaboration: New developers or testers can onboard faster.
Audit readiness: Detailed notes aid in security and compliance reviews.
Be concise but clear: Use plain language to describe the API’s function.
Include key details: Mention core use cases (e.g., “Updates lettering item categories for truck signs”).
Keep it updated: Regularly review and revise descriptions as APIs evolve.
