global-type-combinators-id-exists
Overview
This rule belongs to the apimatic-preliminary-validation ruleset and states that:
The id of a global type combinators entry uniquely identifies this entry from others in the same list as well as from the names of the global models in the Custom Types list. It is mostly useful for export to other formats that support global type combinators.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Warning |
| Message | Id is found to be missing for the current global type combinators entry. |
| Code | APIMATICPRE_V582 |
| Type | Validation |
| Rule System | Semantic |
| Broad Category | Global Types/Models |
| Products Impacted | Code Generation, Developer Experience Portal, API Transformer |
| Tags | preliminary checks validation apimatic id global type combinators anyOf oneOf not |
Suggested Fixes
- Make sure that a unique id is assigned to the global type combinators entry which is unique not just from other global type combinators entries but also unique from the globally defined custom types.
- Ids are compared in a case-sensitive manner.