Request descriptions and documentation in Postman - Interactive Code Practice

Practice - 5 Tasks

1fill in blank

easy

Complete the code to add a description to a Postman request.

Postman

{
  "info": {
    "name": "Sample Request",
    "description": [1]
  }
}

Drag options to blanks, or click blank then click option'

Anull

B12345

C"This is a test request"

Dtrue

Attempts:

3 left

💡 Hint

Common Mistakes

Using a number or boolean instead of a string for description.

Leaving the description empty or null.

The description field should be a string explaining the request. Option C correctly provides a string description.

2fill in blank

medium

Complete the code to add a description to a Postman request body.

Postman

{
  "request": {
    "body": {
      "mode": "raw",
      "raw": "{\"name\": \"John\"}",
      "options": {
        "raw": {
          "language": "json",
          "description": [1]
        }
      }
    }
  }
}

Drag options to blanks, or click blank then click option'

A"User data in JSON format"

Bfalse

C123

Dnull

Attempts:

3 left

💡 Hint

Common Mistakes

Using non-string values for description.

Confusing description with other fields like language.

The description inside the body options should be a string explaining the body content. Option A correctly describes the JSON data.

3fill in blank

hard

Fix the error in the request description field to make it valid JSON.

Postman

{
  "info": {
    "name": "Test Request",
    "description": [1]
  }
}

Drag options to blanks, or click blank then click option'

AA valid description

Btrue

C123

D"A valid description"

Attempts:

3 left

💡 Hint

Common Mistakes

Leaving the description unquoted causing JSON syntax errors.

Using numbers or booleans instead of strings.

The description must be a string enclosed in quotes to be valid JSON. Option D correctly uses quotes.

4fill in blank

hard

Fill both blanks to add a description and a summary to a Postman request documentation.

Postman

{
  "item": [
    {
      "name": "Get User",
      "request": {
        "description": [1]
      },
      "event": [
        {
          "listen": "test",
          "script": {
            "exec": [
              "// Test script",
              "// Summary: [2]"
            ]
          }
        }
      ]
    }
  ]
}

Drag options to blanks, or click blank then click option'

A"Fetch user details by ID"

B"Check user data correctness"

C"Summary: Verify user retrieval"

D"Test user response format"

Attempts:

3 left

💡 Hint

Common Mistakes

Mixing up description and summary texts.

Using non-string values or missing quotes.

The description explains the request purpose (A), and the summary in the test script comments (C) describes the test goal.

5fill in blank

hard

Fill all three blanks to document a Postman request with description, test summary, and assertion message.

Postman

{
  "item": [
    {
      "name": "Create Item",
      "request": {
        "description": [1]
      },
      "event": [
        {
          "listen": "test",
          "script": {
            "exec": [
              "pm.test('[2]', function () {",
              "  pm.response.to.have.status(201);",
              "  pm.expect(pm.response.text()).to.include('[3]');",
              "});"
            ]
          }
        }
      ]
    }
  ]
}

Drag options to blanks, or click blank then click option'

A"Create a new item in the database"

B"Status code is 201 Created"

C"Item created successfully"

D"Check response time"

Attempts:

3 left

💡 Hint

Common Mistakes

Using unrelated or vague test names.

Not matching assertion messages to expected response.

The description (A) explains the request. The test name (B) describes the assertion. The assertion message (C) confirms success.