properties

Use the properties extension to define properties for referencing in an API.

The properties extension has the following structure:
properties:
   property_1:
      value: default_value_1
      description: description_1
      encoded: encoded_boolean_1
   property_2
      value: default_value_2
      description: description_2
      encoded: encoded_boolean_2
The following table lists the fields found in the properties extension:
Table 1. The properties extension
Property Required Description Data type
property Yes The name of the property. It is used when referencing the property. Note that this is the field name, not the contents of the field. Object
value No The default value that the property takes. It can be empty. String
description No The description of the property. It can be empty. String
encoded No Specifies whether to encode the value of this property. Boolean
The following example shows a sample properties field:
  properties:
    ID:
      value: 1234
      description: An ID to be used for validating.
      encoded: false