APIMatic Preliminary Linting
Overview
APIMatic performs some preliminary linting checks on the user-provided API specification to ensure that the API specification document produces desired output in any of the APIMatic products including API Transformer, SDK/Portal generation, etc.
| Property | Value |
|---|---|
| Id | apimatic-preliminary-linting |
| Code | APIMATICPRE_L |
| Ruleset Type | Linting |
| Default Severity of All Rules | Warning |
| Rule System | Semantic |
| Tags | preliminary checks linting apimatic |
Categories of Rules
- API (APIMATICPRE_L001 - APIMATICPRE_L010)
- Server Configuration (APIMATICPRE_L011 - APIMATICPRE_L020)
- Authentication (APIMATICPRE_L021 - APIMATICPRE_L040)
- Endpoints (APIMATICPRE_L041 - APIMATICPRE_L100)
- Types/Models (APIMATICPRE_L101 - APIMATICPRE_L200)
- Miscellaneous (APIMATICPRE_L201 - APIMATICPRE_L499)
API Rules
Server Configuration Rules
Authentication Rules
- no-oauth-2-parameter-paramformats (APIMATICPRE_L021)
- api-authentication-mechanism-defined (APIMATICPRE_L022)
- unique-authentication-options (APIMATICPRE_L023)
- unique-authentication-schemes-in-group-auth-option (APIMATICPRE_L024)
- two-or-more-authentication-schemes-in-group-auth-option (APIMATICPRE_L025)
Endpoints Rules
- endpoint-group-globally-defined (APIMATICPRE_L041)
- optional-template-path-parameters (APIMATICPRE_L042)
- atleast-one-template-parameter-reference (APIMATICPRE_L043)
- no-endpoint-authorization-header (APIMATICPRE_L044)
- concrete-response-type (APIMATICPRE_L045)
Types/Models Rules
- no-base-type-field-redeclaration (APIMATICPRE_L101)
- no-model-circular-dependency (APIMATICPRE_L102)
- valid-number-type-restriction-attribute (APIMATICPRE_L103)
- maximum-limit-greater-or-equal-minimum-limit (APIMATICPRE_L104)
- no-inline-model-definition (APIMATICPRE_L105)
- no-redundant-model (APIMATICPRE_L106)
- atleast-one-or-more-model (APIMATICPRE_L107)
- non-zero-multiple-of-restriction-attribute (APIMATICPRE_L108)
- non-empty-type-combinator-metadata (APIMATICPRE_L195)
- atleast-one-type-combinator-set-in-global-type-combinators (APIMATICPRE_L196)