Demo: review a request schema before API docs publish
Schema diagrams are most useful when they reveal which fields are required, which arrays contain objects, and where composition changes behavior.
- Required fields should stand out from optional metadata.
- Enums should be visible because they often become UI states or SDK constants.
- oneOf and anyOf need human explanation in docs, not only a visual branch.
{
"type": "object",
"required": ["email", "plan"],
"properties": {
"email": {"type": "string", "format": "email"},
"plan": {"type": "string", "enum": ["free", "pro"]},
"metadata": {"type": "object", "additionalProperties": true}
}
}This small schema already shows required fields, enum states, and open metadata.