unique-global-type-combinators-id
Overview
This rule belongs to the apimatic-preliminary-validation ruleset and states that:
The id of a global type combinators entry must uniquely identify this entry from others in the same list as well as from the names of the global models in the Custom Types list.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Warning |
| Message | Id specified for the global type combinators entry is non-unique. |
| Code | APIMATICPRE_V583 |
| 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 the id assigned to the global type combinators entry is unique not just from other global type combinators entries but also unique from the globally defined custom types.
- Assign a unique id to each of the global type combinators entry.
- Ids are compared in a case-sensitive manner.