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.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Scope value has missing corresponding scope name. |
| Code | APIMATICPRE_V064 |
| Type | Validation |
| Rule System | Semantic |
| Broad Category | Authentication |
| Products Impacted | Code Generation, Developer Experience Portal, API Transformer |
| Tags | preliminary 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.