OpenAPI v3 Syntax Linting
Overview
Linting checks performed on provided OpenAPI v3 file to check its conformance to recommended syntax practices by the OpenAPI v3 official standards document.
Property | Value |
---|---|
Id | openapi-v3-syntax-linting |
Code | OPENAPI3SYNTAX_L |
Ruleset Type | Linting |
Default Severity of All Rules | Warning |
Rule System | Syntax |
Tags | openapi3 openapi syntax linting |
For More Information
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#openapi-specification
- https://docs.apimatic.io/rulesets/overview/
Categories of Rules
- Licenses (OPENAPI3SYNTAX_L001 - OPENAPI3SYNTAX_L019)
- Operations (OPENAPI3SYNTAX_L020 - OPENAPI3SYNTAX_L039)
- Parameters (OPENAPI3SYNTAX_L040 - OPENAPI3SYNTAX_L059)
- Request Body (OPENAPI3SYNTAX_L060 - OPENAPI3SYNTAX_L079)
- Encoding (OPENAPI3SYNTAX_L080 - OPENAPI3SYNTAX_L099)
- Responses (OPENAPI3SYNTAX_L100 - OPENAPI3SYNTAX_L119)
- Headers (OPENAPI3SYNTAX_L120 - OPENAPI3SYNTAX_L139)
- Schemas (OPENAPI3SYNTAX_L140 - OPENAPI3SYNTAX_L159)