Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 1.27 KB

xms-client-name-property.md

File metadata and controls

46 lines (30 loc) · 1.27 KB
Raw

XmsClientNameProperty

Category

SDK Error

Applies to

ARM and Data plane OpenAPI(swagger) specs

Output Message

Value of 'x-ms-client-name' cannot be the same as '{0}' Property/Model.

Description

The x-ms-client-name extension is used to change the name of a parameter or property in the generated code. By using the 'x-ms-client-name' extension, a name can be defined for use specifically in code generation, separately from the name on the wire. It can be used for query parameters and header parameters, as well as properties of schemas. This name is case sensitive.

Why the rule is important

This value cannot be same as parameter name or property name, because having the same name invalidates the usage.

How to fix the violation

Please specify non-empty x-ms-client-name, different from the model/property name that you'd like to be generated.

Impact on generated code

Generated SDK code will expose the corresponding client name on property or model.

Examples

{
  "definitions": {
    "Product": {
      "x-ms-external" : true,
      "properties": {
        "product_id": {
          "type": "string",
          "x-ms-client-name": "SKU"
        }
     }
  }
}