Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


The property "type": "node" isn't required (or recommended) but can be used for clarity.  If the  "type" , "required" and/or "descriptionrequired" properties  properties are used, the sub-properties must be  contained inside of  the "items" property:

Code Block
{
	"properties": {
		...
		"address": {
			"type": "node",
			"description": "Customer primary address",
			"items": {
				"city": {...},
				"state": {...}
			}
		}
	}
}

...

PropertyDescription
requiredA non-null value for this item must be provided (false by default). Items inside the container-node can
override the parent container node's required setting.
itemsContains the list of sub-properties in the node. This is required only if the "type", "required" and/or "description" properties are used.descriptionA human-readable description of the property.


String

A string of characters variable. The following properties are applied when data is posted for this item:

...