DescriptionAndTitleMissing

Category

SDK Warning

Applies to

ARM and Data plane OpenAPI(swagger) specs

Output Message

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

Description

The definition must have at least one of the properties - description/title.

Why the rule is important

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

How to fix the violation

For each definition, provide at least one of the properties - description/title.