Skip to main content

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.

PropertyValue
EnabledYes
Maximum SeverityInformation
MessageThe scope value is missing from OAuth flow.
CodeOPENAPI3DOCSGEN_L870
TypeLinting
Rule SystemSemantic
Broad CategoryOpenAPI OAuth 2.0 Flows
Products ImpactedDeveloper Experience Portal
Tagsdocumentation 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.

For More Information