pre-defined-security-requirement-scope-in-security-scheme

Overview

This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:

A security requirement must only use pre-defined scopes from the security scheme scope definitions.

Property	Value
Enabled	Yes
Maximum Severity	Error
Message	Security requirement scope in the corresponding security scheme is not defined.
Code	OPENAPI3APIMATIC_L933
Type	Linting
Rule System	Semantic
Broad Category	OpenAPI Security Requirements
Products Impacted	API Transformer, Code Generation, Developer Experience Portal
Tags	openapi3 openapi apimatic semantic linting pre-defined security requirement scope scheme

Suggested Fixes

• Make sure that the security requirement uses only the pre-defined scopes from the scope definitions of the corresponding security scheme.
• Make sure that the scope name used in the security requirement matches the name specified for the scope in the security scheme definition.

For More Information

• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-requirement-object
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
• https://docs.apimatic.io/rulesets/overview/