ParameterDescriptionRequired

Category

SDK Error

Applies to

ARM and Data plane OpenAPI(swagger) specs

Output Message

{0} lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation.

Description

A parameter must have 'description' property.

Why the rule is important

Appropriate documentation could not be generated without the 'description' property.

How to fix the violation

For each parameter, provide a 'description' property.