Schema Properties
Overview
Merge uses JSON Schema conventions in schemas returned from Merge (e.g., the request_schema returned from a /meta endpoint) for scalable schemas and programmatic convenience.
In these schemas:
- Shared Properties specify type definitions with fields like “type” and “description”
- Object, Array and Enum Fields will have additional schema properties as described further below
Shared Properties
All fields in JSON Schemas returned from Merge have basic properties like “type” and “description” that specify field types.
| Property | Type | Description |
type | string | Denotes the type of data stored in this field. |
description | string | If available, will explain what data is expected. |
Object Fields
In addition to shared properties, object fields in JSON Schemas returned from Merge will have these additional properties:
| Property | Type | Description |
properties | object | Denotes the object’s key-value pairs where the key is the field name and the value is the sub-schema of the field. |
required | array | Denotes which object fields are required or optional when making a POST request. |
Array Fields
In addition to shared properties, array fields in JSON Schemas returned from Merge will have these additional properties:
| Property | Type | Description |
items | object |
|
Enum Fields
In addition to shared properties, enum fields that have a limited array of string choices will have these additional properties:
| Property | Type | Description |
enum_information | array | Denotes the available choices for enum fields. |
enum | array | Denotes the available choices for enum fields and adheres to JSON Schema convention by only communicating the enum value (excluding properties like This compliant |