[Solved] Identify the error in this OpenAPI YAML snippet: paths: /login: post: summary: User login responses: 200: description: Login successful | Rest API

Rest API - API Documentation

Identify the error in this OpenAPI YAML snippet:

paths:
  /login:
    post:
      summary: User login
      responses:
        200:
          description: Login successful

ASummary field is not allowed under POST

BMissing requestBody for POST method

CResponse code 200 should be a string '200', not a number

DPath should start with a capital letter

Step-by-Step Solution

Solution:

Step 1: Check response code format
OpenAPI requires response codes as strings, e.g., '200', not numbers.
Step 2: Verify other fields
Summary is allowed; requestBody is optional; path case is flexible.
Final Answer:
Response code 200 should be a string '200', not a number -> Option C
Quick Check:
Response codes must be strings [OK]

Quick Trick: Always quote response codes as strings in YAML [OK]

Common Mistakes:

MISTAKES

Master "API Documentation" in Rest API

9 interactive learning modes - each teaches the same concept differently

More Rest API Quizzes

Identify the error in this OpenAPI YAML snippet: