valid-apimatic-extension-property-type
Overview
This rule belongs to the openapi-v3-codegen-syntax-linting ruleset and states that:
Type of an APIMatic specific extension property must be in accordance with the type expected for that property.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Warning |
| Message | APIMatic Extension property type does not conform to the expected property type. |
| Code | OPENAPI3CODEGENSYNTAX_L900 |
| Type | Linting |
| Rule System | Syntax |
| Broad Category | Miscellaneous |
| Products Impacted | Code Generation, Developer Experience Portal |
| Tags | code generation sdks openapi3 openapi syntax linting apimatic type extension property |
Suggested Fixes
- If an array is expected, ensure that your value is surrounded by square brackets [ and ].
- If an array is not expected, ensure that your value contains a single item only and is not surrounded by square brackets [ and ].
- If a numeric value is expected, ensure that your value is a valid number and it is not surrounded by single or double quotes.
- If a string value is expected, ensure that it is escaped properly and surrounded by quotes if necessary.
- If an object is expected, ensure that your value is a key-value map.