required-security-scheme-type
Overview
This rule belongs to the openapi-v3-standards-validation ruleset and states that:
The Security Scheme Object must specify the type of the security scheme using the type property.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Required property type in Security Scheme Object is missing. |
| Code | OPENAPI3STANDARDS_V410 |
| Type | Validation |
| Rule System | Semantic |
| Broad Category | Security Schemes |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi standards semantic validation type security scheme security |
Suggested Fixes
- Add missing
typeproperty in the Security Scheme Object. - Make sure that the
typeproperty is not null or empty.
For More Information
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#openapi-specification
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#security-scheme-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-scheme-object
- https://docs.apimatic.io/rulesets/overview/