non-conflicting-schema-property-name-and-schema-key
Overview
This rule belongs to the openapi-v3-codegen-linting ruleset and states that:
Schema keys and property names should not conflict with each other. Each schema should have a unique key that serves as its identifier, and property names within the schema should also be unique. Conflicts occur when a schema key is the same as a property name, leading to ambiguity and potential issues with the interpretation of the schema.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Warning |
| Message | Schema key and property name conflict with each other. |
| Code | OPENAPI3CODEGEN_L620 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Schemas |
| Products Impacted | Code Generation, Developer Experience Portal |
| Tags | code generation sdks openapi3 openapi semantic linting apimatic properties schema key conflict |
Suggested Fixes
- Update schema key/name to ensure uniqueness and remove the conflict.