non-empty-oauth-flow-scope-description
Overview
This rule belongs to the openapi-v3-docsgen-linting ruleset and states that:
OAuthFlow object should have a non-null and non-empty scope vaule.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Information |
| Message | The scope value is missing from OAuth flow. |
| Code | OPENAPI3DOCSGEN_L870 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI OAuth 2.0 Flows |
| Products Impacted | Developer Experience Portal |
| Tags | documentation generation documentation docs openapi3 openapi semantic linting apimatic oauth flow scope value description |
Suggested Fixes
- Add a user-friendly scope value for the OAuthFlow object.