# Descriptions for API Collections & Endpoints

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.

### Steps to Add a Description to an API Collection

<figure><img src="https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-c36f318bcff16d2abbf693795214983895b23eb3%2Fimage%20(1)%20(1)%20(1)%20(1)%20(1)%20(1)%20(1)%20(1)%20(1)%20(1)%20(1)%20(1)%20(1).png?alt=media" alt=""><figcaption></figcaption></figure>

1. **Navigate to API Discovery:**
   * On the left sidebar, click on **API Discovery**.
2. **Select the API Collection:**
   * Choose your desired API collection from the list.
3. **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.

***

### Steps to Add a Description to an API Endpoint

<figure><img src="https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2F9SV6bBeTEHVXehAMIqpR%2Fapiendpoints.webp?alt=media&#x26;token=43286856-a828-43a7-956a-6eec833feac9" alt="" width="563"><figcaption></figcaption></figure>

1. **View the API Collection:**
   * Go to the **API Discovery** section and select your API collection.
2. **Select the Endpoint:**
   * Click on the endpoint you want to describe.
3. **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.

***

### Why Add Descriptions?

* **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.

***

### Best Practices

* **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.
