Request descriptions and documentation in Postman - Build an Automation Script

Add descriptions to API requests and verify documentation

Preconditions (2)

Step 1: Open the Postman application

Step 2: Navigate to the existing collection

Step 3: Select an API request in the collection

Step 4: Click on the 'Description' tab or field for the request

Step 5: Enter a clear description explaining the request purpose and parameters

Step 6: Save the request

Step 7: Open the collection documentation view

Step 8: Verify that the request description appears correctly in the documentation

✅ Expected Result: The request description is saved and displayed correctly in the collection documentation

Automation Requirements - Postman Test Scripts (JavaScript)

Assertions Needed:

Verify the request description field is not empty

Verify the description text matches the expected content

Best Practices:

Use descriptive and clear text for request descriptions

Keep descriptions concise but informative

Use Postman scripting to validate request metadata

Maintain documentation updated with request changes

Automated Solution

Postman

pm.test('Request description is present and correct', () => {
    const description = pm.request.description?.content || '';
    pm.expect(description).to.not.be.empty;
    pm.expect(description).to.include('purpose'); // Replace 'purpose' with expected keyword in description
});

This test script runs after the request execution in Postman.

It accesses the request's description content using pm.request.description.content.

First, it checks that the description is not empty to ensure documentation exists.

Then, it verifies the description includes an expected keyword or phrase to confirm correctness.

This helps keep request documentation accurate and visible in Postman collections.

Common Mistakes - 3 Pitfalls

Not adding any description to the request

Using vague or overly technical language in descriptions

Not verifying descriptions via automated tests

Bonus Challenge

Now add automated tests to verify descriptions for all requests in the collection

Show Hint

Practice

1. What is the main purpose of adding a description to a Postman request?

easy

A. To run the request faster

B. To change the request URL automatically

C. To explain what the API request does for better understanding

D. To hide the request from other users

Solution

1. Step 1: Understand the role of descriptions in Postman

   Descriptions provide clear notes about what each API request does, helping users understand its purpose.

2. Step 2: Identify the correct purpose among options

   Only To explain what the API request does for better understanding correctly states that descriptions explain the API request for better understanding.

3. Final Answer:

   To explain what the API request does for better understanding -> Option C

4. Quick Check:

   Descriptions clarify request purpose = A [OK]

Hint: Descriptions explain requests clearly for users [OK]

Common Mistakes:

• Thinking descriptions change request behavior
• Assuming descriptions speed up requests
• Believing descriptions hide requests

2. Which Postman tab should you use to add a description to an API request?

easy

A. Description tab

B. Tests tab

C. Headers tab

D. Body tab

Solution

1. Step 1: Identify where descriptions are added in Postman

   Descriptions are added in the Description tab of a request to provide notes and explanations.

2. Step 2: Match the correct tab with the description function

   The Description tab is designed specifically for adding descriptive text, unlike Tests, Headers, or Body tabs.

3. Final Answer:

   Description tab -> Option A

4. Quick Check:

   Description tab holds notes = B [OK]

Hint: Use Description tab to add notes to requests [OK]

Common Mistakes:

• Confusing Description tab with Tests tab
• Trying to add descriptions in Headers or Body tabs
• Not knowing where to write request notes

3. Consider this Postman request description snippet:

"Fetches user data by ID. Returns 404 if user not found."

What is the main benefit of including this description?

medium

A. It informs users what the request does and possible responses

B. It automatically handles 404 errors in the request

C. It changes the API response format

D. It encrypts the user data in the response

Solution

1. Step 1: Analyze the description content

   The description explains the request purpose and what happens if the user is not found (404 error).

2. Step 2: Determine the benefit of this explanation

   This helps users understand the request behavior and expected responses, improving clarity.

3. Final Answer:

   It informs users what the request does and possible responses -> Option A

4. Quick Check:

   Description explains purpose and responses = A [OK]

Hint: Descriptions tell what request does and possible results [OK]

Common Mistakes:

• Thinking descriptions affect request execution
• Assuming descriptions change API data
• Believing descriptions encrypt or secure data

4. You added a description to a Postman request but it does not appear in the documentation. What is the most likely reason?

medium

A. You added the description in the Tests tab instead of Description tab

B. You forgot to save the request after adding the description

C. Descriptions are not supported in Postman documentation

D. The request URL is invalid

Solution

1. Step 1: Check how descriptions appear in documentation

   Descriptions must be saved with the request to show up in generated documentation.

2. Step 2: Identify common mistakes preventing description display

   Not saving changes after editing description is a common cause; descriptions are supported and must be in Description tab.

3. Final Answer:

   You forgot to save the request after adding the description -> Option B

4. Quick Check:

   Unsaved description won't show = C [OK]

Hint: Always save request after editing description [OK]

Common Mistakes:

• Adding description in wrong tab
• Assuming descriptions don't show in docs
• Ignoring save button after editing

5. You want to document a complex API request in Postman that has multiple query parameters and possible error codes. Which approach best improves clarity in the request description?

hard

A. Write a short description and add details in the Tests tab

B. Leave the description empty and rely on the request name only

C. Add only the URL in the description without explanations

D. Write a detailed description listing each query parameter and error code with explanations

Solution

1. Step 1: Understand documentation needs for complex requests

   Complex requests benefit from detailed descriptions explaining parameters and error codes for user clarity.

2. Step 2: Evaluate options for best clarity

   Write a detailed description listing each query parameter and error code with explanations provides detailed, helpful notes; other options omit important info or place it in wrong tabs.

3. Final Answer:

   Write a detailed description listing each query parameter and error code with explanations -> Option D

4. Quick Check:

   Detailed descriptions improve clarity = D [OK]

Hint: Detail parameters and errors in description for clarity [OK]

Common Mistakes:

• Skipping detailed notes for complex requests
• Putting explanations in Tests tab instead of Description
• Relying only on request name without description