no-coordinating-conjunctions-in-schema-component-key
Overview
This rule belongs to the openapi-v3-codegen-linting ruleset and states that:
When defining schemas in the component object, the name of the schema should be descriptive and concise. Avoid using coordinating conjunctions such as and, but or for in the schema name. This helps keep the schema name clear and to the point, making it easier to understand and use.
| Property | Value |
|---|---|
| Enabled | No |
| Maximum Severity | Warning |
| Message | Schema component Key should not contain coordinating conjunctions. |
| Code | OPENAPI3CODEGEN_L134 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Components |
| Products Impacted | Code Generation, Developer Experience Portal |
| Tags | code generation sdks openapi3 openapi semantic linting apimatic components schemas key coordinating conjunction |
Suggested Fixes
- Remove all coordinating conjuctions from the schema key present in components object.