DescriptiveDescriptionRequired

Category

SDK Error

Applies to

ARM and Data plane OpenAPI(swagger) specs

Output Message

The value provided for description is not descriptive enough. Accurate and descriptive description is essential for maintaining reference documentation.

Description

The value of the 'description' property must be descriptive. It cannot be spaces or empty description.

Why the rule is important

Appropriate documentation could not be generated without a detailed 'description' value.

How to fix the violation

For each 'description' property, provide a detailed description value.