non-empty-api-key-security-parameter-name
Overview
This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:
The name property is used to identify the parameter or header that contains the API key. The name property of an API key security scheme must not be empty or null.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | The name property of an API key security scheme is empty or null. |
| Code | OPENAPI3APIMATIC_L870 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Security Schemes |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi apimatic semantic linting empty api key security parameter name |
Suggested Fixes
- Make sure to provide a valid parameter name for the API key security scheme.