no-trailing-leading-spaces-in-api-key-security-scheme-name
Overview
This rule belongs to the openapi-v3-apimatic-syntax-linting
ruleset and states that:
The name of an ApiKey Security Scheme should not contain any leading or trailing white-space characters.
Property | Value |
---|---|
Enabled | Yes |
Maximum Severity | Warning |
Message | Leading or trailing white-space character found in ApiKey Security Scheme name. |
Code | OPENAPI3APIMATICSYNTAX_L870 |
Type | Linting |
Rule System | Syntax |
Broad Category | OpenAPI Security Schemes |
Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
Tags | openapi3 openapi syntax linting apimatic security scheme ApiKey name leading trailing whitespace character |
Suggested Fixes
- Remove all leading or trailing white-space characters such as spaces, tabs, or line breaks from ApiKey security scheme name.
For More Information
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#components-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-scheme-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
- https://docs.apimatic.io/rulesets/overview/