Method 1: Metadata for localized strings

This method can only be used for JSON objects.

To define that a field or property contains localized data, perform these steps:

  1. Set the localized property type to object.
  2. Include a Boolean property called x-localized and set it to true.
  3. To define a maximum length for each of the localized strings, include a property called x-propertiesMaxLength.
    For information on localized strings in data objects, see the "Data object definitions for localized string values" topic.
  4. Specify the maximum string length.
  5. Optionally, in your localized property definition, set the additionalProperties property to true.
    Note: The additionalProperties property is not required within your definition because when this property is not specified, the default is true.