Skip to main content

unique-global-type-combinators-id

Overview

This rule belongs to the apimatic-post-processing-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. If that is not the case, the id will automatically be assigned a unique value.

PropertyValue
EnabledNo
Maximum SeverityWarning
MessageId specified for the global type combinators entry is non-unique.
CodeAPIMATICPOSTPROCESS_V493
TypeValidation
Rule SystemSemantic
Broad CategoryGlobal Types/Models
Products ImpactedCode Generation, Developer Experience Portal, API Transformer
Tagsapimatic postprocessing validation 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.