OpenAPI v3 Linting for Agentic Tools
Overview
A comprehensive set of linting checks performed by APIMatic on OpenAPI v3 specifications to ensure alignment with recommended practices that improve agentic tools output, code generation, and overall API clarity.
| Property | Value |
|---|---|
| Id | openapi-v3-agentic-tools-linting |
| Code | OPENAPI3AGENTICTOOLS_L |
| Ruleset Type | Linting |
| Default Severity of All Rules | Warning |
| Rule System | Semantic |
| Products Impacted | Agentic Tools Generation, Developer Experience Portal |
| Tags | code generation AI Agentic tools mcp llm openapi3 openapi semantic linting apimatic |
For More Information
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
- https://docs.apimatic.io/rulesets/overview/
Categories of Rules
- OpenAPI Root Information (OPENAPI3AGENTICTOOLS_L001 - OPENAPI3AGENTICTOOLS_L039)
- OpenAPI Info (OPENAPI3AGENTICTOOLS_L040 - OPENAPI3AGENTICTOOLS_L059)
- OpenAPI Contact (OPENAPI3AGENTICTOOLS_L060 - OPENAPI3AGENTICTOOLS_L079)
- OpenAPI Licenses (OPENAPI3AGENTICTOOLS_L080 - OPENAPI3AGENTICTOOLS_L099)
- OpenAPI Servers (OPENAPI3AGENTICTOOLS_L100 - OPENAPI3AGENTICTOOLS_L149)
- OpenAPI Components (OPENAPI3AGENTICTOOLS_L150 - OPENAPI3AGENTICTOOLS_L179)
- OpenAPI Paths (OPENAPI3AGENTICTOOLS_L180 - OPENAPI3AGENTICTOOLS_L199)
- OpenAPI Path Items (OPENAPI3AGENTICTOOLS_L200 - OPENAPI3AGENTICTOOLS_L229)
- OpenAPI Operations (OPENAPI3AGENTICTOOLS_L230 - OPENAPI3AGENTICTOOLS_L299)
- OpenAPI External Documentation (OPENAPI3AGENTICTOOLS_L300 - OPENAPI3AGENTICTOOLS_L329)
- OpenAPI Parameters (OPENAPI3AGENTICTOOLS_L330 - OPENAPI3AGENTICTOOLS_L369)
- OpenAPI Request Body (OPENAPI3AGENTICTOOLS_L370 - OPENAPI3AGENTICTOOLS_L399)
- OpenAPI Media Types (OPENAPI3AGENTICTOOLS_L400 - OPENAPI3AGENTICTOOLS_L429)
- OpenAPI Encoding (OPENAPI3AGENTICTOOLS_L430 - OPENAPI3AGENTICTOOLS_L459)
- OpenAPI Responses (OPENAPI3AGENTICTOOLS_L460 - OPENAPI3AGENTICTOOLS_L499)
- OpenAPI Callbacks (OPENAPI3AGENTICTOOLS_L500 - OPENAPI3AGENTICTOOLS_L529)
- OpenAPI Links (OPENAPI3AGENTICTOOLS_L530 - OPENAPI3AGENTICTOOLS_L569)
- OpenAPI Headers (OPENAPI3AGENTICTOOLS_L570 - OPENAPI3AGENTICTOOLS_L599)
- OpenAPI Tags (OPENAPI3AGENTICTOOLS_L600 - OPENAPI3AGENTICTOOLS_L629)
- OpenAPI References (OPENAPI3AGENTICTOOLS_L630 - OPENAPI3AGENTICTOOLS_L659)
- OpenAPI Schemas (OPENAPI3AGENTICTOOLS_L660 - OPENAPI3AGENTICTOOLS_L799)
- OpenAPI Discriminators (OPENAPI3AGENTICTOOLS_L800 - OPENAPI3AGENTICTOOLS_L839)
- OpenAPI XML (OPENAPI3AGENTICTOOLS_L840 - OPENAPI3AGENTICTOOLS_L869)
- OpenAPI Security Schemes (OPENAPI3AGENTICTOOLS_L870 - OPENAPI3AGENTICTOOLS_L909)
- OpenAPI OAuth 2.0 Flows (OPENAPI3AGENTICTOOLS_L910 - OPENAPI3AGENTICTOOLS_L929)
- OpenAPI Security Requirements (OPENAPI3AGENTICTOOLS_L930 - OPENAPI3AGENTICTOOLS_L949)
- OpenAPI Vendor Extensions (OPENAPI3AGENTICTOOLS_L950 - OPENAPI3AGENTICTOOLS_L969)
- Miscellaneous (OPENAPI3AGENTICTOOLS_L970 - OPENAPI3AGENTICTOOLS_L999)
OpenAPI Root Information Rules
OpenAPI Info Rules
- required-info-description (OPENAPI3AGENTICTOOLS_L040)
- required-environment-information (OPENAPI3AGENTICTOOLS_L041)
OpenAPI Operations Rules
- required-operation-summary (OPENAPI3AGENTICTOOLS_L230)
- required-operation-description (OPENAPI3AGENTICTOOLS_L231)
OpenAPI Parameters Rules
- required-parameter-description (OPENAPI3AGENTICTOOLS_L330)
- at-least-one-parameter-example (OPENAPI3AGENTICTOOLS_L331)