Skip to main content

non-conflicting-schema-property-name-and-schema-title

Overview

This rule belongs to the openapi-v3-codegen-linting ruleset and states that:

Schema title and property names should not conflict with each other. Each schema should have a unique title that serves as its identifier, and property names within the schema should also be unique. Conflicts occur when a schema title is the same as a property name, leading to ambiguity and potential issues with the interpretation of the schema.

PropertyValue
EnabledYes
Maximum SeverityWarning
MessageSchema title and property name conflict with each other.
CodeOPENAPI3CODEGEN_L621
TypeLinting
Rule SystemSemantic
Broad CategoryOpenAPI Schemas
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagscode generation sdks openapi3 openapi semantic linting apimatic properties schema key conflict

Suggested Fixes

  • Update schema title to ensure uniqueness and remove the conflict.

For More Information