Web Interface JSON schema support

Overview of what parts of JSON schema are supported by the NGIXN Management Suite App Delivery Manager web interface.

This topic describes an early access feature. These features are provided for you to try before they are generally available. You shouldn't use early access features for production purposes.

Share your thoughts about the documentation by taking this short survey: https://forms.gle/w6eDi53F4UcmDjw68.

Overview

The web interface has limited support for JSON schema. This document describes what is supported. The web interface will not render properly if JSON schema features outside this document are used.

type
- Boolean
- String
- Numeric
- Object
- Array
title
description

Boolean field support

Example:

{
  "boolField1": {
    "type": "boolean"
  }
}

Exception: required boolean fields are not supported.

Reference: boolean

String field

Supported features:

pattern
minLength
maxLength
examples
enum

Example:

// Regular string field
{
  "test": {
    "type": "string",
    "pattern": "^[A-Za-z0-9\s]*$",
    "minLength": 1,
    "maxLength": 140,
    "examples": ["value 1", "value 2"]
  }
}

// String Select field
{
  "method": {
    "type": "string",
    "enum": ["GET", "POST", "PUT", "DELETE"]
  }
}

// String MultiSelect field
{
  "method": {
    "type": "array",
    "items": {
      "type": "string",
      "enum": ["GET", "POST", "PUT", "DELETE"]
    }
  }
}

Reference: string

Numeric field

Supported types:

integer (integral numbers)
number (float).

Supported features:

multipleOf
exclusiveMinimum
exclusiveMaximum
minimum
maximum
examples
enum

Example:

// Regular numeric field
{
  "proxyTimeout": {
    "type": "number",
    "multipleOf": 10,
    "minimum": 10,
    "maximum": 1000,
    "examples": [50, 120, 870]
  }
}

// Numeric Select field
{
  "proxyTimeout": {
    "type": "number",
    "enum": [10, 20, 30, 40, 50]
  }
}

// Numeric MultiSelect field
{
  "proxyTimeout": {
    "type": "array",
    "items": {
      "type": "number",
      "enum": [10, 20, 30, 40, 50]
    }
  }
}

Reference: numeric.

Object field

Supported features:

properties
required

Example:

{
  "server": {
    "type": "object",
    "properties": {
      "isBackup": { "type": "boolean" },
      "weight": { "type": "integer" },
      "service": { "type": "string" }
    },
    "required": ["service"]
  }
}

Reference: object.

Array field

Supported features:

minItems – minimum number of items in array
maxItems – maximum number of items in array
uniqueItems – if array should cosist of unique items or not

Example:

{
  "headers": {
    "type": "array",
    "items": {
      "type": "object",
      "properties": {
        "name": { "type": "string" },
        "value": { "type": "string" }
      },
      "required": []
    }
  }
}

Reference: array.