non-empty-schema-component-key
Overview
This rule belongs to the openapi-v3-apimatic-linting
ruleset and states that:
The unique key specified for the schema in the components object must be non-empty.
Property | Value |
---|---|
Enabled | Yes |
Maximum Severity | Error |
Message | The schema key defined in the components object is empty. |
Code | OPENAPI3APIMATIC_L151 |
Type | Linting |
Rule System | Semantic |
Broad Category | OpenAPI Components |
Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
Tags | openapi3 openapi apimatic semantic linting component schema key empty |
Suggested Fixes
- Make sure that the schema component key is not null or empty.
- Remove all the schemas from components object where the schema key is empty or assign a valid alphanumeric value to it.