required-schema-description
Overview
This rule belongs to the openapi-v3-agentic-tools-linting ruleset and states that:
Schema descriptions help agentic tools understand the purpose and structure of models. Include meaningful descriptions to improve generated code and AI reasoning.
| Property | Value |
|---|---|
| Enabled | No |
| Maximum Severity | Warning |
| Message | Schema should include a non-empty description. |
| Code | OPENAPI3AGENTICTOOLS_L660 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Schemas |
| Products Impacted | Agentic Tools Generation, Developer Experience Portal |
| Tags | code generation AI Agentic tools mcp llm openapi3 openapi semantic linting apimatic schema description |
Suggested Fixes
- Add a clear description to each schema.
- Ensure the description accurately represents the schema.