OpenAPI v3 APIMatic Syntax Linting
Overview
Linting checks performed by APIMatic on provided OpenAPI v3 file to check its conformance to recommended syntax practices for better API consumption.
Property | Value |
---|---|
Id | openapi-v3-apimatic-syntax-linting |
Code | OPENAPI3APIMATICSYNTAX_L |
Ruleset Type | Linting |
Default Severity of All Rules | Warning |
Rule System | Syntax |
Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
Tags | openapi3 openapi syntax 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 (OPENAPI3APIMATICSYNTAX_L001 - OPENAPI3APIMATICSYNTAX_L039)
- OpenAPI Info (OPENAPI3APIMATICSYNTAX_L040 - OPENAPI3APIMATICSYNTAX_L059)
- OpenAPI Contact (OPENAPI3APIMATICSYNTAX_L060 - OPENAPI3APIMATICSYNTAX_L079)
- OpenAPI Licenses (OPENAPI3APIMATICSYNTAX_L080 - OPENAPI3APIMATICSYNTAX_L099)
- OpenAPI Servers (OPENAPI3APIMATICSYNTAX_L100 - OPENAPI3APIMATICSYNTAX_L149)
- OpenAPI Components (OPENAPI3APIMATICSYNTAX_L150 - OPENAPI3APIMATICSYNTAX_L179)
- OpenAPI Paths (OPENAPI3APIMATICSYNTAX_L180 - OPENAPI3APIMATICSYNTAX_L199)
- OpenAPI Path Items (OPENAPI3APIMATICSYNTAX_L200 - OPENAPI3APIMATICSYNTAX_L229)
- OpenAPI Operations (OPENAPI3APIMATICSYNTAX_L230 - OPENAPI3APIMATICSYNTAX_L299)
- OpenAPI External Documentation (OPENAPI3APIMATICSYNTAX_L300 - OPENAPI3APIMATICSYNTAX_L329)
- OpenAPI Parameters (OPENAPI3APIMATICSYNTAX_L330 - OPENAPI3APIMATICSYNTAX_L369)
- OpenAPI Request Body (OPENAPI3APIMATICSYNTAX_L370 - OPENAPI3APIMATICSYNTAX_L399)
- OpenAPI Media Types (OPENAPI3APIMATICSYNTAX_L400 - OPENAPI3APIMATICSYNTAX_L429)
- OpenAPI Encoding (OPENAPI3APIMATICSYNTAX_L430 - OPENAPI3APIMATICSYNTAX_L459)
- OpenAPI Responses (OPENAPI3APIMATICSYNTAX_L460 - OPENAPI3APIMATICSYNTAX_L499)
- OpenAPI Callbacks (OPENAPI3APIMATICSYNTAX_L500 - OPENAPI3APIMATICSYNTAX_L529)
- OpenAPI Links (OPENAPI3APIMATICSYNTAX_L530 - OPENAPI3APIMATICSYNTAX_L569)
- OpenAPI Headers (OPENAPI3APIMATICSYNTAX_L570 - OPENAPI3APIMATICSYNTAX_L599)
- OpenAPI Tags (OPENAPI3APIMATICSYNTAX_L600 - OPENAPI3APIMATICSYNTAX_L629)
- OpenAPI References (OPENAPI3APIMATICSYNTAX_L630 - OPENAPI3APIMATICSYNTAX_L659)
- OpenAPI Schemas (OPENAPI3APIMATICSYNTAX_L660 - OPENAPI3APIMATICSYNTAX_L799)
- OpenAPI Discriminators (OPENAPI3APIMATICSYNTAX_L800 - OPENAPI3APIMATICSYNTAX_L839)
- OpenAPI XML (OPENAPI3APIMATICSYNTAX_L840 - OPENAPI3APIMATICSYNTAX_L869)
- OpenAPI Security Schemes (OPENAPI3APIMATICSYNTAX_L870 - OPENAPI3APIMATICSYNTAX_L909)
- OpenAPI OAuth 2.0 Flows (OPENAPI3APIMATICSYNTAX_L910 - OPENAPI3APIMATICSYNTAX_L929)
- OpenAPI Security Requirements (OPENAPI3APIMATICSYNTAX_L930 - OPENAPI3APIMATICSYNTAX_L949)
- Miscellaneous (OPENAPI3APIMATICSYNTAX_L950 - OPENAPI3APIMATICSYNTAX_L999)
OpenAPI Info Rules
- no-trailing-leading-spaces-in-info-title (OPENAPI3APIMATICSYNTAX_L040)
- valid-info-version (OPENAPI3APIMATICSYNTAX_L041)
- valid-image-uri (OPENAPI3APIMATICSYNTAX_L042)
OpenAPI Servers Rules
- no-trailing-leading-spaces-in-environment-name (OPENAPI3APIMATICSYNTAX_L100)
- no-trailing-leading-spaces-in-server-name (OPENAPI3APIMATICSYNTAX_L101)
- no-server-url-trailing-slash (OPENAPI3APIMATICSYNTAX_L102)
- no-trailing-leading-spaces-in-server-variable-name (OPENAPI3APIMATICSYNTAX_L103)
- no-trailing-leading-spaces-in-server-parameter-name (OPENAPI3APIMATICSYNTAX_L104)
OpenAPI Paths Rules
- no-paths-key-trailing-slash (OPENAPI3APIMATICSYNTAX_L180)
- non-empty-parameter-name-in-path-url-template-expression (OPENAPI3APIMATICSYNTAX_L181)
OpenAPI Operations Rules
- no-trailing-leading-spaces-in-operation-id (OPENAPI3APIMATICSYNTAX_L230)
- no-trailing-leading-spaces-in-operation-summary (OPENAPI3APIMATICSYNTAX_L231)
OpenAPI Parameters Rules
- no-trailing-leading-spaces-in-parameter-name (OPENAPI3APIMATICSYNTAX_L330)
- valid-rfc-6570-parameter-Name (OPENAPI3APIMATICSYNTAX_L331)
- valid-boolean-parameter-name (OPENAPI3APIMATICSYNTAX_L332)
OpenAPI Tags Rules
OpenAPI Schemas Rules
- no-trailing-leading-spaces-in-schema-title (OPENAPI3APIMATICSYNTAX_L660)
- no-trailing-leading-spaces-in-schema-properties-key (OPENAPI3APIMATICSYNTAX_L661)
- valid-schema-enum-item-type (OPENAPI3APIMATICSYNTAX_L662)
OpenAPI XML Rules
- no-trailing-leading-spaces-in-xml-name (OPENAPI3APIMATICSYNTAX_L840)
- valid-xml-name (OPENAPI3APIMATICSYNTAX_L841)
OpenAPI Security Schemes Rules
- no-trailing-leading-spaces-in-api-key-security-scheme-name (OPENAPI3APIMATICSYNTAX_L870)
- no-trailing-leading-spaces-in-additional-header-name (OPENAPI3APIMATICSYNTAX_L871)