required-operation-description
Overview
This rule belongs to the openapi-v3-agentic-tools-linting ruleset and states that:
A detailed operation description enables agentic tools to infer behavior, side effects, and constraints. Ensure each operation includes a complete and meaningful description.
| Property | Value |
|---|---|
| Enabled | No |
| Maximum Severity | Error |
| Message | Operation must include a non-empty description. |
| Code | OPENAPI3AGENTICTOOLS_L231 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Operations |
| Products Impacted | Agentic Tools Generation, Developer Experience Portal |
| Tags | code generation AI Agentic tools mcp llm openapi3 openapi semantic linting apimatic operation description |
Suggested Fixes
- Add a detailed description to the operation.
- Ensure the description accurately reflects the operation's behavior.