Skip to main content

OpenAPI v3 Linting for APIMatic Portal Generation

Overview

Linting checks performed by APIMatic on provided OpenAPI v3 file to check its conformance to recommended practices for a more user-friendly API documentation.

PropertyValue
Idopenapi-v3-docsgen-linting
CodeOPENAPI3DOCSGEN_L
Ruleset TypeLinting
Default Severity of All RulesWarning
Rule SystemSemantic
Products ImpactedDeveloper Experience Portal
Tagsdocumentation generation documentation docs openapi3 openapi semantic linting apimatic

For More Information

Categories of Rules

OpenAPI Info Rules

OpenAPI Servers Rules

OpenAPI Path Items Rules

OpenAPI Operations Rules

OpenAPI Parameters Rules

OpenAPI Request Body Rules

OpenAPI Media Types Rules

OpenAPI Responses Rules

OpenAPI Examples Rules

OpenAPI Headers Rules

OpenAPI Tags Rules

OpenAPI Schemas Rules

OpenAPI Security Schemes Rules

OpenAPI OAuth 2.0 Flows Rules