XmsExamplesRequired

Category

Documentation Error

Applies to

ARM and Data plane OpenAPI(swagger) specs

Output Message

Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.{0}.

Description

Verifies whether x-ms-examples are provided for each operation or not.

Why the rule is important

x-ms-examples are used in model validation. Benefits

How to fix the violation

Please refer the documentation of x-ms-examples.

Impact on generated code

N/A.

Examples

Please refer the documentation of x-ms-examples.