APIMatic Post-Processing Validation
Overview
APIMatic post-processes a user-provided API specification document and automatically fixes some common issues. This validation mainly informs users about these issues and the fixes performed.
| Property | Value |
|---|---|
| Id | apimatic-post-processing-validation |
| Code | APIMATICPOSTPROCESS_V |
| Ruleset Type | Validation |
| Default Severity of All Rules | Warning |
| Rule System | Semantic |
| Tags | apimatic postprocessing validation |
Categories of Rules
- Server Configuration (APIMATICPOSTPROCESS_V001 - APIMATICPOSTPROCESS_V100)
- Authentication (APIMATICPOSTPROCESS_V101 - APIMATICPOSTPROCESS_V200)
- Endpoints (APIMATICPOSTPROCESS_V201 - APIMATICPOSTPROCESS_V250)
- Endpoint Parameters (APIMATICPOSTPROCESS_V251 - APIMATICPOSTPROCESS_V300)
- Endpoint Responses (APIMATICPOSTPROCESS_V301 - APIMATICPOSTPROCESS_V350)
- Types (APIMATICPOSTPROCESS_V351 - APIMATICPOSTPROCESS_V400)
- Global Types/Models (APIMATICPOSTPROCESS_V401 - APIMATICPOSTPROCESS_V500)
- Examples (APIMATICPOSTPROCESS_V501 - APIMATICPOSTPROCESS_V600)
- Miscellaneous (APIMATICPOSTPROCESS_V601 - APIMATICPOSTPROCESS_V650)
Server Configuration Rules
- server-parameter-cannot-be-array (APIMATICPOSTPROCESS_V001)
- server-parameter-cannot-be-map-object (APIMATICPOSTPROCESS_V002)
- server-parameter-cannot-be-constant (APIMATICPOSTPROCESS_V003)
Authentication Rules
- valid-oauth-2-parameter-format (APIMATICPOSTPROCESS_V101)
- supported-oauth-2-parameter-format (APIMATICPOSTPROCESS_V102)
- non-empty-authentication-scheme-name (APIMATICPOSTPROCESS_V103)
- non-null-non-empty-applied-authentication-scheme-name (APIMATICPOSTPROCESS_V104)
- unique-authentication-option-name (APIMATICPOSTPROCESS_V105)
- unique-authentication-options (APIMATICPOSTPROCESS_V106)
- authentication-scheme-referenced-by-auth-option (APIMATICPOSTPROCESS_V107)
- unique-authentication-schemes-in-group-auth-option (APIMATICPOSTPROCESS_V108)
- two-or-more-authentication-schemes-in-group-auth-option (APIMATICPOSTPROCESS_V109)
Endpoints Rules
- endpoint-group-globally-defined (APIMATICPOSTPROCESS_V201)
- unique-endpoint-scopes (APIMATICPOSTPROCESS_V202)
Endpoint Parameters Rules
- valid-parameter-primitive-type (APIMATICPOSTPROCESS_V251)
- predefined-endpoint-path-template-parameter (APIMATICPOSTPROCESS_V252)
- valid-template-parameter-format (APIMATICPOSTPROCESS_V253)
Endpoint Responses Rules
- valid-response-primitive-type (APIMATICPOSTPROCESS_V301)
- non-empty-response-content-media-type (APIMATICPOSTPROCESS_V302)
- sorted-error-codes (APIMATICPOSTPROCESS_V303)
Types Rules
- native-primitive-type (APIMATICPOSTPROCESS_V351)
- dynamic-entities-cannot-be-arrays (APIMATICPOSTPROCESS_V352)
- pre-defined-model (APIMATICPOSTPROCESS_V353)
- type-combinator-cases-meta-count-must-match (APIMATICPOSTPROCESS_V354)
- non-empty-global-type-combinators-reference-name (APIMATICPOSTPROCESS_V355)
Global Types/Models Rules
- valid-numeric-enum-default-value (APIMATICPOSTPROCESS_V401)
- required-enum-field-default-value (APIMATICPOSTPROCESS_V402)
- required-discriminator-field (APIMATICPOSTPROCESS_V403)
- valid-custom-type-field-primitive-type (APIMATICPOSTPROCESS_V404)
- non-empty-global-type-combinators-key (APIMATICPOSTPROCESS_V491)
- global-type-combinators-id-exists (APIMATICPOSTPROCESS_V492)
- unique-global-type-combinators-id (APIMATICPOSTPROCESS_V493)
- non-empty-discriminator-mapping-key (APIMATICPOSTPROCESS_V494)
- non-null-non-empty-discriminator-mapping-value (APIMATICPOSTPROCESS_V495)
Examples Rules
- valid-example-value (APIMATICPOSTPROCESS_V501)
- example-value-restrictions (APIMATICPOSTPROCESS_V502)
- no-example-for-error-with-no-model (APIMATICPOSTPROCESS_V503)
- unique-example-ids (APIMATICPOSTPROCESS_V504)
- non-empty-non-null-example-id (APIMATICPOSTPROCESS_V505)
- valid-example-external-value (APIMATICPOSTPROCESS_V506)
- required-example-value-or-external-url (APIMATICPOSTPROCESS_V507)
- supported-default-value (APIMATICPOSTPROCESS_V508)
- sample-value-no-white-spaces (APIMATICPOSTPROCESS_V509)
- valid-boolean-value (APIMATICPOSTPROCESS_V510)