no-articles-in-schema-component-key
Overview
This rule belongs to the openapi-v3-codegen-linting ruleset and states that:
The schema name defined in the OpenAPI Component object should be concise and to the point. To maintain consistency, avoid using articles (such as a, an, or the) in schema names as they are not necessary and can make the name longer than needed. Long or overly descriptive schema names can impact readability and increase the potential for errors when working with the API definition.
| Property | Value |
|---|---|
| Enabled | No |
| Maximum Severity | Warning |
| Message | Schema component key should not contain articles. |
| Code | OPENAPI3CODEGEN_L133 |
| 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 articles |
Suggested Fixes
- Remove all articles from the schema key present in components object.