OpenAPI v3 Syntax Validation
Overview
Validation checks performed on provided OpenAPI v3 file to check its conformance to OpenAPI 3.n syntax rules.
Property | Value |
---|---|
Id | openapi-v3-syntax-validation |
Code | OPENAPI3SYNTAX_V |
Ruleset Type | Validation |
Default Severity of All Rules | Error |
Rule System | Syntax |
Tags | openapi3 openapi syntax validation |
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
- Servers (OPENAPI3SYNTAX_V001 - OPENAPI3SYNTAX_V019)
- Components (OPENAPI3SYNTAX_V020 - OPENAPI3SYNTAX_V039)
- Paths (OPENAPI3SYNTAX_V040 - OPENAPI3SYNTAX_V059)
- Responses (OPENAPI3SYNTAX_V060 - OPENAPI3SYNTAX_V079)
- Callbacks (OPENAPI3SYNTAX_V080 - OPENAPI3SYNTAX_V099)
- Links (OPENAPI3SYNTAX_V100 - OPENAPI3SYNTAX_V119)
- References (OPENAPI3SYNTAX_V120 - OPENAPI3SYNTAX_V139)
- Schemas (OPENAPI3SYNTAX_V140 - OPENAPI3SYNTAX_V159)
- Discriminators (OPENAPI3SYNTAX_V160 - OPENAPI3SYNTAX_V179)
- XML (OPENAPI3SYNTAX_V180 - OPENAPI3SYNTAX_V199)
- Specification Extensions (OPENAPI3SYNTAX_V200 - OPENAPI3SYNTAX_V219)
- Miscellaneous (OPENAPI3SYNTAX_V220 - OPENAPI3SYNTAX_V299)
Servers Rules
Components Rules
Paths Rules
Responses Rules
- valid-response-status-code-or-range (OPENAPI3SYNTAX_V060)
- valid-response-link-key (OPENAPI3SYNTAX_V061)
Callbacks Rules
Links Rules
- valid-operation-ref (OPENAPI3SYNTAX_V100)
- valid-link-parameter-expression (OPENAPI3SYNTAX_V101)
- valid-link-request-body-expression (OPENAPI3SYNTAX_V102)
References Rules
Schemas Rules
- valid-schema-dollar-id-format (OPENAPI3SYNTAX_V140)
- valid-schema-dollar-anchor-format (OPENAPI3SYNTAX_V141)
- valid-schema-dollar-dynamic-anchor-format (OPENAPI3SYNTAX_V142)
- valid-schema-content-media-type (OPENAPI3SYNTAX_V143)