Rest API - API Documentation
What is wrong with this OpenAPI snippet?
components:
schemas:
User:
type: object
properties:
id:
type: integer
name:
type: string
required: id
What is wrong with this OpenAPI snippet? components: schemas: User: type: object properties: id: type: integer name: type: string required: id
medium📝 Debug Q7 of 15
Step-by-Step Solution
Solution:
Step 1: Check the required field format
Therequiredfield must be an array of strings, e.g.,['id'], not a single string.Step 2: Validate other schema rules
Properties belong inside schemas, type 'object' is valid, and schema names are usually PascalCase.Final Answer:
The required field should be a list, not a single value -> Option CQuick Check:
Required is a list of property names [OK]
Quick Trick: Required properties must be in a list [OK]
Common Mistakes:
MISTAKES- Using string instead of list for required
- Misplacing properties
- Incorrect schema naming conventions
Master "API Documentation" in Rest API
Want More Practice?
15+ quiz questions · All difficulty levels · Free
Free Signup - Practice All QuestionsMore Rest API Quizzes