Skip to content

Latest commit

 

History

History
25 lines (13 loc) · 859 Bytes

parameter-not-using-common-types.md

File metadata and controls

25 lines (13 loc) · 859 Bytes
Raw

ParameterNotUsingCommonTypes

Category

ARM Warning

Applies to

ARM OpenAPI(swagger) specs

Output Message

Not using json ref for parameter "{0}" that is defined in common-types

Description

Some commonly used parameters are defined in the common-types directory. These parameters should be referenced instead of explicitly redefining them.

Why the rule is important

To reduce duplication and maintain consistent structure in ARM specifications.

How to fix the violation

Ensure any parameters that share a name with those in common-types are declared using a JSON reference (e.g. "$ref": ./path/to/file#/parameters/CommonParameter) to common types. Common-types parameters are defined in types.json here.