Description formatting (Markdown) in Postman - Practice Problems & Coding Challenges

Challenge - 5 Problems

🧠 Conceptual

intermediate

How does Postman render Markdown in descriptions?

In Postman, which of the following Markdown elements will correctly render as bold text in a request description?

A **bold text**

B `bold text`

C _bold text_

D ~bold text~

💡 Hint

Think about the Markdown syntax for bold text.

In Markdown, double asterisks or double underscores make text bold. Postman supports this syntax in descriptions.

❓ Predict Output

intermediate

What is the rendered output of this Markdown in Postman description?

Given this Markdown snippet in a Postman request description:

# Header 1
Some *italic* text and a [link](https://example.com)

What will the rendered output look like?

A Header 1 as normal text, italic text as normal, and a link shown as URL only

B A large header 'Header 1', italic text 'italic', and a clickable link labeled 'link' pointing to https://example.com

C Header 1 in bold, italic text in bold, and a link that is not clickable

D Plain text showing '# Header 1', '*italic*', and '[link](https://example.com)' without formatting

💡 Hint

Markdown headers start with # and links use [text](url) syntax.

Markdown renders # Header 1 as a large header, *italic* as italic text, and [link](url) as a clickable hyperlink.

❓ assertion

advanced

Which assertion correctly checks for presence of bold text in Postman test script?

You want to write a Postman test script to verify that the response description contains bold text formatted with Markdown. Which assertion is correct?

Postman

pm.test('Description contains bold text', () => {
    const desc = pm.response.json().description;
    // Which assertion below is correct?
});

A pm.expect(desc).to.match(/\*\*.*\*\*/);

B pm.expect(desc).to.include('**');

C pm.expect(desc).to.include('<strong>');

D pm.expect(desc).to.have.property('bold');

💡 Hint

Markdown bold uses double asterisks, so a regex can detect it.

Since the description is raw Markdown, checking for ** with a regex is best. HTML tags like <strong> won't appear in raw Markdown.

🔧 Debug

advanced

Why does this Markdown not render as a list in Postman description?

This Markdown is used in a Postman request description:

- Item 1
-Item 2
 - Item 3

Why does only 'Item 1' render as a list item?

A Because the indentation before 'Item 3' is too large

B Because Postman does not support lists in descriptions

C Because '-Item 2' lacks a space after the dash, so it's not recognized as a list item

D Because the dash must be replaced with asterisk (*) for lists in Postman

💡 Hint

Markdown requires a space after the dash for list items.

In Markdown, list items must have a space after the dash. '-Item 2' is treated as normal text, so only 'Item 1' is a list item.

❓ framework

expert

How to automate validation of Markdown formatting in Postman descriptions?

You want to create an automated test framework that validates Markdown formatting in Postman request descriptions to ensure consistent style. Which approach is best?

A Write Selenium UI tests to open Postman app and visually check description rendering

B Export Postman collection and manually review descriptions for Markdown correctness

C Use Postman test scripts to parse the description text and apply regex checks for Markdown patterns

D Use a third-party Markdown linter tool integrated in CI pipeline to scan exported Postman collection JSON

💡 Hint

Think about scalable, automated validation outside Postman UI.

Exporting the collection JSON and running a Markdown linter in CI is scalable and automated. Postman test scripts can't parse descriptions before execution, and UI tests are brittle.

Practice

1. What is the main purpose of using Markdown in Postman descriptions?

easy

A. To store environment variables

B. To make descriptions neat and easy to read

C. To change the API request method

D. To write code that runs tests automatically

Solution

1. Step 1: Understand Markdown's role in Postman

   Markdown is used to format text, making it clear and organized.

2. Step 2: Identify the purpose of descriptions

   Descriptions help explain tests and requests clearly to the team.

3. Final Answer:

   To make descriptions neat and easy to read -> Option B

4. Quick Check:

   Markdown = format text [OK]

Hint: Markdown formats text for clarity [OK]

Common Mistakes:

• Confusing Markdown with test automation
• Thinking Markdown changes API methods
• Assuming Markdown stores variables

2. Which of the following is the correct way to make text bold in a Postman description using Markdown?

easy

A. *bold text*

B. _bold text_

C. `bold text`

D. **bold text**

Solution

1. Step 1: Recall Markdown syntax for bold text

   Bold text is created by wrapping text with double asterisks ** like **bold**.

2. Step 2: Compare options

   **bold text** uses **bold text**, which is correct. *bold text* or _bold text_ use single * or _, which make italics. `bold text` uses backticks for code formatting.

3. Final Answer:

   **bold text** -> Option D

4. Quick Check:

   Bold = **text** [OK]

Hint: Use double asterisks for bold text [OK]

Common Mistakes:

• Using single asterisk for bold (makes italics)
• Using backticks instead of asterisks
• Confusing italics and bold syntax

3. Given this Postman description snippet using Markdown:

### Test Steps
1. Send request
2. Check response
- Status code should be 200
- Body should contain 'success'

What will the rendered description look like?

medium

A. A heading 'Test Steps' followed by a numbered list with two items and a bulleted list under the second item

B. Plain text with no formatting

C. A bulleted list only with no heading

D. A numbered list with four items and no heading

Solution

1. Step 1: Interpret Markdown syntax

   ### creates a heading. Numbers create a numbered list. Hyphens create bullet points.

2. Step 2: Analyze the structure

   Heading 'Test Steps' appears. Then a numbered list with two items followed by a bulleted list with two points under the second item.

3. Final Answer:

   A heading 'Test Steps' followed by a numbered list with two items and a bulleted list under the second item -> Option A

4. Quick Check:

   ### = heading, 1./2. = numbered list, - = bullets [OK]

Hint: ### = heading, numbers = list, - = bullets [OK]

Common Mistakes:

• Ignoring nested lists
• Thinking numbers create bullets
• Missing the heading formatting

4. You wrote this Markdown in a Postman description:

**Test Result:
Passed**

But it does not show bold text as expected. What is the error?

medium

A. Newline inside ** breaks bold formatting; use inline text instead

B. Missing closing ** at the end

C. Markdown does not support bold in Postman

D. You must use single asterisks for bold

Solution

1. Step 1: Understand Markdown bold syntax

   Bold text must be continuous inside ** without line breaks.

2. Step 2: Identify the problem with newline

   Newline inside ** causes Markdown to break formatting, so 'Passed' is not bold.

3. Final Answer:

   Newline inside ** breaks bold formatting; use inline text instead -> Option A

4. Quick Check:

   Bold text must be on one line [OK]

Hint: Keep bold text on one line [OK]

Common Mistakes:

• Adding line breaks inside bold markers
• Thinking Markdown is unsupported in Postman
• Using wrong asterisks count for bold

5. You want to add a clickable link in your Postman description that says API Docs and points to https://docs.example.com. Which Markdown syntax is correct?

hard

A. "API Docs":https://docs.example.com

B. API Docs

C. [API Docs](https://docs.example.com)

D. {API Docs}(https://docs.example.com)

Solution

1. Step 1: Recall Markdown link syntax

   Markdown links use [text](url) format to create clickable links.

2. Step 2: Evaluate options

   [API Docs](https://docs.example.com) uses correct Markdown syntax. API Docs is HTML, which may work but is not Markdown. The remaining options are invalid Markdown.

3. Final Answer:

   [API Docs](https://docs.example.com) -> Option C

4. Quick Check:

   Links = [text](url) [OK]

Hint: Use [text](url) for links [OK]

Common Mistakes:

• Using HTML tags instead of Markdown
• Wrong bracket types for links
• Confusing quotes with brackets