Skip to main content

OpenAPI v3 Syntax Linting for APIMatic Portal Generation

Overview

Syntax 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-syntax-linting
CodeOPENAPI3DOCSGENSYNTAX_L
Ruleset TypeLinting
Default Severity of All RulesWarning
Rule SystemSyntax
Products ImpactedDeveloper Experience Portal
Tagsdocumentation generation documentation docs openapi3 openapi syntax linting apimatic

For More Information

Categories of Rules

OpenAPI Info Rules

OpenAPI Servers Rules

OpenAPI Path Items Rules

OpenAPI Operations Rules

OpenAPI Operation Test Cases Rules

OpenAPI External Documentation 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

OpenAPI Security Requirements Rules