APIMatic Validation for Code Generation
Overview
APIMatic performs some preliminary checks on the user-provided API specification document to ensure that it meets the basic requirements for generating a valid output during SDK and Portal generation.
Property | Value |
---|---|
Id | apimatic-codegen-validation |
Code | APIMATICCODEGEN_V |
Ruleset Type | Validation |
Default Severity of All Rules | Error |
Rule System | Semantic |
Tags | apimatic code generation codegen sdks portal docs validation apimatic |
For More Information
Categories of Rules
- Name Conventions (APIMATICCODEGEN_V001 - APIMATICCODEGEN_V005)
- XML Attributes (APIMATICCODEGEN_V006 - APIMATICCODEGEN_V020)
- Authentication (APIMATICCODEGEN_V021 - APIMATICCODEGEN_V030)
- Server Configuration (APIMATICCODEGEN_V031 - APIMATICCODEGEN_V040)
- Endpoints (APIMATICCODEGEN_V041 - APIMATICCODEGEN_V070)
- Endpoint Parameters (APIMATICCODEGEN_V071 - APIMATICCODEGEN_V100)
- Endpoint Responses (APIMATICCODEGEN_V101 - APIMATICCODEGEN_V130)
- Global Types/Models (APIMATICCODEGEN_V131 - APIMATICCODEGEN_V160)
- Test Cases (APIMATICCODEGEN_V161 - APIMATICCODEGEN_V200)
- Test Generation Settings (APIMATICCODEGEN_V201 - APIMATICCODEGEN_V250)
- CodeGen Settings (APIMATICCODEGEN_V251 - APIMATICCODEGEN_V500)
Name Conventions Rules
XML Attributes Rules
- valid-xml-namespace-conventions (APIMATICCODEGEN_V006)
- unique-element-xml-node-names-in-model (APIMATICCODEGEN_V007)
- unique-attribute-xml-node-names-in-model (APIMATICCODEGEN_V008)
- no-dynamic-type-usage-with-xml (APIMATICCODEGEN_V009)
Authentication Rules
Server Configuration Rules
Endpoints Rules
- atleast-one-endpoint (APIMATICCODEGEN_V041)
- unique-endpoint-group-name (APIMATICCODEGEN_V042)
- non-conflicting-endpoint-name (APIMATICCODEGEN_V043)
- non-conflicting-method-name (APIMATICCODEGEN_V044)
- valid-method-name-conventions (APIMATICCODEGEN_V045)
Endpoint Parameters Rules
- unique-endpoint-parameter-name (APIMATICCODEGEN_V071)
- same-parameters-name-for-parameter-collection (APIMATICCODEGEN_V072)
- no-complex-types-in-non-body-parameters (APIMATICCODEGEN_V073)
- no-array-header-parameters (APIMATICCODEGEN_V074)
- no-array-file-form-parameters (APIMATICCODEGEN_V075)
Endpoint Responses Rules
- response-mapping-required-field (APIMATICCODEGEN_V101)
- valid-response-mapping-field-elements (APIMATICCODEGEN_V102)
- response-mapping-data-field-value-for-complex-types (APIMATICCODEGEN_V103)
Global Types/Models Rules
- unique-model-names (APIMATICCODEGEN_V131)
- valid-enum-field-name-conventions (APIMATICCODEGEN_V132)
- non-conflicting-model-and-endpoint-group-names (APIMATICCODEGEN_V133)
- model-atleast-one-field (APIMATICCODEGEN_V134)
- unique-field-name (APIMATICCODEGEN_V135)
- non-conflicting-model-and-field-name (APIMATICCODEGEN_V136)
Test Cases Rules
- non-conflicting-test-case-name (APIMATICCODEGEN_V161)
- predefined-test-input-parameter (APIMATICCODEGEN_V162)
- valid-input-parameter-test-value (APIMATICCODEGEN_V163)
- input-parameter-test-value-restrictions (APIMATICCODEGEN_V164)
- optional-query-parameters-test-case (APIMATICCODEGEN_V165)
- optional-field-parameters-test-case (APIMATICCODEGEN_V166)
- valid-test-case-expected-status (APIMATICCODEGEN_V167)
- allowed-test-case-body-match-mode (APIMATICCODEGEN_V168)
- valid-test-case-expected-body-value (APIMATICCODEGEN_V169)
- test-case-expected-body-value-restrictions (APIMATICCODEGEN_V170)
Test Generation Settings Rules
- valid-timeout-testgen-setting (APIMATICCODEGEN_V201)
- valid-precision-delta-testgen-setting (APIMATICCODEGEN_V202)
- pre-defined-testgen-environment (APIMATICCODEGEN_V203)
CodeGen Settings Rules
- valid-request-timeout-codegen-setting (APIMATICCODEGEN_V251)
- valid-php-composer-package-name-codegen-setting (APIMATICCODEGEN_V252)
- valid-php-namespace-name-codegen-setting (APIMATICCODEGEN_V253)
- java-group-id-codegen-setting-match-naming-rules (APIMATICCODEGEN_V254)
- java-artifact-id-codegen-setting-match-naming-rules (APIMATICCODEGEN_V255)
- controller-postfix-codegen-setting-naming-conventions (APIMATICCODEGEN_V256)
- valid-do-not-split-words-codegen-setting-entry (APIMATICCODEGEN_V257)
- valid-usage-example-codegen-setting-endpoint-group (APIMATICCODEGEN_V258)
- usage-example-pre-defined-endpoint (APIMATICCODEGEN_V259)