Optimizely · Schema

SchemaField

A field definition within a domain object type

A/B TestingContent ManagementCustomer DataE-CommerceExperimentationFeature FlagsMarketing

Properties

Name Type Description
name string Field name
display_name string Human-readable display name
type string Data type of the field
description string Description of the field
View JSON Schema on GitHub

JSON Schema

optimizely-schemafield-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SchemaField",
  "title": "SchemaField",
  "type": "object",
  "description": "A field definition within a domain object type",
  "properties": {
    "name": {
      "type": "string",
      "description": "Field name"
    },
    "display_name": {
      "type": "string",
      "description": "Human-readable display name"
    },
    "type": {
      "type": "string",
      "description": "Data type of the field",
      "enum": [
        "string",
        "number",
        "boolean",
        "timestamp"
      ]
    },
    "description": {
      "type": "string",
      "description": "Description of the field"
    }
  }
}