required-discriminator-field
Overview
This rule belongs to the apimatic-preliminary-validation ruleset and states that:
If a discriminator is set for a model, it must have a corresponding discriminator field/property defined in its fields.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Discriminator field/property definition is missing in the model. |
| Code | APIMATICPRE_V503 |
| Type | Validation |
| Rule System | Semantic |
| Broad Category | Global Types/Models |
| Products Impacted | Code Generation, Developer Experience Portal, API Transformer |
| Tags | preliminary checks validation apimatic discriminator field property type custom type model complex model |
Suggested Fixes
- Make sure that if you have a discriminator set for a model, then an explicit discriminator field/property definition is also added in the same model's fields/properties.
- The name of the discriminator property/field must exactly match the name of the discriminator set in the model/type definition.
- Only a string typed discriminator property/field is currently supported.