non-empty-oauth-flow-scopes-key
Overview
This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:
The scope key is used to define the scopes or permissions associated with the OAuth flow. A non-empty scope key must be provided in all OAuth scope definitions.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Scope key is missing in the OAuth flow object. |
| Code | OPENAPI3APIMATIC_L912 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI OAuth 2.0 Flows |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi apimatic semantic linting empty oauth flow scopes key |
Suggested Fixes
- Ensure that no scope key is empty.
- Ensure that scopes map includes at least one scope key.