required-description-for-enum-item
Overview
This rule belongs to the openapi-v3-agentic-tools-linting ruleset and states that:
Enum values often carry domain-specific meaning. Use APIMatic's x-enum-elements extension to define readable names and descriptions for each enum item to improve clarity for agentic tools.
| Property | Value |
|---|---|
| Enabled | No |
| Maximum Severity | Error |
| Message | No description found for enum item. |
| Code | OPENAPI3AGENTICTOOLS_L661 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Schemas |
| Products Impacted | Agentic Tools Generation, Code Generation, Developer Experience Portal |
| Tags | code generation AI Agentic tools mcp llm openapi3 openapi semantic linting apimatic schema enum name description |
Suggested Fixes
- Use
x-enum-elementsto define display names and descriptions for each enum value.
For More Information
- https://docs.apimatic.io/specification-extensions/swagger-codegen-extensions/#enumeration-extensions
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#schema-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
- https://docs.apimatic.io/rulesets/overview/