valid-api-schemes
Overview
This rule belongs to the swagger-v2-standards-validation ruleset and states that:
The only valid transfer protocols applicable to the API, as per the Swagger v2.0 document, are: http, https, ws, wss.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Invalid scheme found. |
| Code | SWAGGER20STANDARDS_V006 |
| Type | Validation |
| Rule System | Semantic |
| Broad Category | Swagger Root Information |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | swagger2 swagger standards semantic validation schemes scheme |
Suggested Fixes
- Ensure that the scheme entered is only from the list mentioned.
- In case the schemes are not included, the default scheme to be used is the one used to access the Swagger definition itself.