required-info-description
Overview
This rule belongs to the openapi-v3-agentic-tools-linting ruleset and states that:
The 'info' object should contain a clear and informative description that explains the API's purpose, domain, and features. A detailed description significantly improves agentic tools' ability to reason about API behavior and generate accurate guidance or code.
| Property | Value |
|---|---|
| Enabled | No |
| Maximum Severity | Warning |
| Message | The Info object must include a non-empty description. |
| Code | OPENAPI3AGENTICTOOLS_L040 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Info |
| Products Impacted | Agentic Tools Generation, Developer Experience Portal |
| Tags | code generation AI Agentic tools mcp llm openapi3 openapi semantic linting apimatic info description |