OpenAPI v3 Syntax Linting for APIMatic Code Generation
Overview
Linting checks performed by APIMatic on provided OpenAPI v3 file to check its conformance to recommended syntax practices for better code generation experience.
| Property | Value |
|---|---|
| Id | openapi-v3-codegen-syntax-linting |
| Code | OPENAPI3CODEGENSYNTAX_L |
| Ruleset Type | Linting |
| Default Severity of All Rules | Warning |
| Rule System | Syntax |
| Products Impacted | Code Generation, Developer Experience Portal |
| Tags | code generation sdks 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 (OPENAPI3CODEGENSYNTAX_L001 - OPENAPI3CODEGENSYNTAX_L049)
- OpenAPI Info (OPENAPI3CODEGENSYNTAX_L050 - OPENAPI3CODEGENSYNTAX_L059)
- OpenAPI Contact (OPENAPI3CODEGENSYNTAX_L060 - OPENAPI3CODEGENSYNTAX_L069)
- OpenAPI Licenses (OPENAPI3CODEGENSYNTAX_L070 - OPENAPI3CODEGENSYNTAX_L089)
- OpenAPI Servers (OPENAPI3CODEGENSYNTAX_L090 - OPENAPI3CODEGENSYNTAX_L129)
- OpenAPI Components (OPENAPI3CODEGENSYNTAX_L130 - OPENAPI3CODEGENSYNTAX_L159)
- OpenAPI Paths (OPENAPI3CODEGENSYNTAX_L160 - OPENAPI3CODEGENSYNTAX_L169)
- OpenAPI Path Items (OPENAPI3CODEGENSYNTAX_L170 - OPENAPI3CODEGENSYNTAX_L189)
- OpenAPI Operations (OPENAPI3CODEGENSYNTAX_L190 - OPENAPI3CODEGENSYNTAX_L239)
- OpenAPI Operation Settings (OPENAPI3CODEGENSYNTAX_L240 - OPENAPI3CODEGENSYNTAX_L339)
- OpenAPI Operation Test Cases (OPENAPI3CODEGENSYNTAX_L340 - OPENAPI3CODEGENSYNTAX_L439)
- OpenAPI External Documentation (OPENAPI3CODEGENSYNTAX_L440 - OPENAPI3CODEGENSYNTAX_L449)
- OpenAPI Parameters (OPENAPI3CODEGENSYNTAX_L450 - OPENAPI3CODEGENSYNTAX_L479)
- OpenAPI Request Body (OPENAPI3CODEGENSYNTAX_L480 - OPENAPI3CODEGENSYNTAX_L499)
- OpenAPI Media Types (OPENAPI3CODEGENSYNTAX_L500 - OPENAPI3CODEGENSYNTAX_L509)
- OpenAPI Encoding (OPENAPI3CODEGENSYNTAX_L510 - OPENAPI3CODEGENSYNTAX_L519)
- OpenAPI Responses (OPENAPI3CODEGENSYNTAX_L520 - OPENAPI3CODEGENSYNTAX_L539)
- OpenAPI Callbacks (OPENAPI3CODEGENSYNTAX_L540 - OPENAPI3CODEGENSYNTAX_L549)
- OpenAPI Links (OPENAPI3CODEGENSYNTAX_L550 - OPENAPI3CODEGENSYNTAX_L559)
- OpenAPI Headers (OPENAPI3CODEGENSYNTAX_L560 - OPENAPI3CODEGENSYNTAX_L579)
- OpenAPI Tags (OPENAPI3CODEGENSYNTAX_L580 - OPENAPI3CODEGENSYNTAX_L599)
- OpenAPI References (OPENAPI3CODEGENSYNTAX_L600 - OPENAPI3CODEGENSYNTAX_L609)
- OpenAPI Schemas (OPENAPI3CODEGENSYNTAX_L610 - OPENAPI3CODEGENSYNTAX_L699)
- OpenAPI Discriminators (OPENAPI3CODEGENSYNTAX_L700 - OPENAPI3CODEGENSYNTAX_L729)
- OpenAPI XML (OPENAPI3CODEGENSYNTAX_L730 - OPENAPI3CODEGENSYNTAX_L739)
- OpenAPI Security Schemes (OPENAPI3CODEGENSYNTAX_L740 - OPENAPI3CODEGENSYNTAX_L759)
- OpenAPI OAuth 2.0 Flows (OPENAPI3CODEGENSYNTAX_L760 - OPENAPI3CODEGENSYNTAX_L779)
- OpenAPI Security Requirements (OPENAPI3CODEGENSYNTAX_L780 - OPENAPI3CODEGENSYNTAX_L799)
- OpenAPI Code Generation Settings (OPENAPI3CODEGENSYNTAX_L800 - OPENAPI3CODEGENSYNTAX_L899)
- Miscellaneous (OPENAPI3CODEGENSYNTAX_L900 - OPENAPI3CODEGENSYNTAX_L999)
OpenAPI Info Rules
OpenAPI Servers Rules
- valid-environment-name (OPENAPI3CODEGENSYNTAX_L090)
- valid-server-name (OPENAPI3CODEGENSYNTAX_L091)
- valid-server-variables-key (OPENAPI3CODEGENSYNTAX_L092)
- valid-server-parameter-name (OPENAPI3CODEGENSYNTAX_L093)
OpenAPI Components Rules
OpenAPI Path Items Rules
OpenAPI Operations Rules
- valid-operation-id (OPENAPI3CODEGENSYNTAX_L190)
- valid-operation-parameter-name (OPENAPI3CODEGENSYNTAX_L192)
OpenAPI Schemas Rules
- valid-schema-title (OPENAPI3CODEGENSYNTAX_L610)
- valid-schema-properties-key (OPENAPI3CODEGENSYNTAX_L611)
- valid-schema-enum-element-name (OPENAPI3CODEGENSYNTAX_L612)
- no-trailing-leading-spaces-in-schema-enum-element-name (OPENAPI3CODEGENSYNTAX_L613)