Skip to main content



This rule belongs to the apimatic-preliminary-linting ruleset and states that:

When a metadata is specified for each of the type combinator cases, it is expected to add more information to the cases like assigning a user-friendly name to the case, adding additional descriptive content, etc. If, however, the metadata provides none of these details, it is considered redundant.

Maximum SeverityWarning
MessageMetadata specified for a type case adds no new information.
Rule SystemSemantic
Broad CategoryTypes/Models
Products ImpactedCode Generation, Developer Experience Portal, API Transformer
Tagspreliminary checks linting apimatic metadata type cases type combinators anyOf oneOf not

Suggested Fixes

  • Ensure that you provide metadata for each of the type combinator cases. Missing out metadata for any case may affect the overall output quality.
  • Specifying metadata should involve adding descriptive content like a user-friendly name for each case or any other details.