Skip to main content

required-scope-name

Overview

This rule belongs to the apimatic-preliminary-validation ruleset and states that:

A non-empty, non-null scope name must be provided in each authentication scope definition. This name is meant to be a more user-friendly and code-friendly name as compared to the corresponding scope value.

PropertyValue
EnabledYes
Maximum SeverityError
MessageScope value has missing corresponding scope name.
CodeAPIMATICPRE_V064
TypeValidation
Rule SystemSemantic
Broad CategoryAuthentication
Products ImpactedCode Generation, Developer Experience Portal, API Transformer
Tagspreliminary checks validation apimatic name scope oauth 2.0 authentication api

Suggested Fixes

  • Assign code-friendly and user-friendly names for all scope values.
  • The scope names must be unique.
  • Scope names must be non-empty and non-null.

For More Information