app-json_forms Schemas

On this page:

formStruct

{ "$id": "formStruct", "type": "object", "properties": { "nodeId": { "$ref": "#/definitions/nodeId" }, "type": { "type": "string" }, "items": { "type": "array", "items": { "anyOf": [ { "$ref": "#/definitions/container" }, { "$ref": "#/definitions/checkboxField" }, { "$ref": "#/definitions/numberField" }, { "$ref": "#/definitions/textField" }, { "$ref": "#/definitions/textareaField" }, { "$ref": "#/definitions/dropdownField" } ] } } }, "required": [ "type", "items" ], "definitions": { "nodeId": { "type": "string", "examples": [ "kdWO-g4oS3GkzrbqDqCZUw" ] }, "container": { "type": "object", "properties": { "nodeId": { "$ref": "#/definitions/nodeId" }, "type": { "type": "string" }, "title": { "type": "string", "examples": [ "Connection Information" ] }, "description": { "type": "string", "examples": [ "This section describes the connection information for a device." ] }, "items": { "type": "array", "items": { "anyOf": [ { "$ref": "#/definitions/container" }, { "$ref": "#/definitions/checkboxField" }, { "$ref": "#/definitions/numberField" }, { "$ref": "#/definitions/textField" }, { "$ref": "#/definitions/textareaField" }, { "$ref": "#/definitions/dropdownField" } ] } } }, "required": [ "nodeId", "type", "title", "items" ] }, "checkboxField": { "type": "object", "properties": { "nodeId": { "$ref": "#/definitions/nodeId" }, "type": { "type": "string", "const": "boolean" }, "title": { "type": "string", "examples": [ "Allow timeout" ] }, "description": { "type": "string", "examples": [ "Is a timeout allowed to pass this step?" ] }, "default": { "type": "boolean", "examples": [ false ] }, "enum": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "type": "boolean" } } } } }, "required": [ "nodeId", "type", "title", "description" ] }, "numberField": { "type": "object", "properties": { "nodeId": { "$ref": "#/definitions/nodeId" }, "type": { "type": "string" }, "widget": { "type": "string" }, "title": { "type": "string", "examples": [ "Retry attempts" ] }, "description": { "type": "string", "examples": [ "The number of connection retries before timing out." ] }, "placeholder": { "type": "string", "examples": [ "Enter connection retry attempt count" ] }, "required": { "type": "boolean" }, "validation": { "type": "object" } }, "required": [ "nodeId", "type", "title", "description" ] }, "textField": { "type": "object", "properties": { "nodeId": { "$ref": "#/definitions/nodeId" }, "type": { "type": "string" }, "title": { "type": "string", "examples": [ "Device Name" ] }, "description": { "type": "string", "examples": [ "A unique name of the target device." ] }, "placeholder": { "type": "string", "examples": [ "Enter the device's name" ] }, "required": { "type": "boolean" }, "pattern": { "type": "string", "examples": [ "regex" ] }, "validation": { "type": "object" } }, "required": [ "nodeId", "type", "title", "description" ] }, "textareaField": { "type": "object", "properties": { "nodeId": { "$ref": "#/definitions/nodeId" }, "type": { "type": "string" }, "widget": { "type": "string" }, "title": { "type": "string", "examples": [ "Device Name" ] }, "description": { "type": "string", "examples": [ "A unique name of the target device." ] }, "placeholder": { "type": "string", "examples": [ "Enter the device's name" ] }, "required": { "type": "boolean" }, "pattern": { "type": "string", "examples": [ "regex" ] }, "validation": { "type": "object" } }, "required": [ "nodeId", "type", "title", "description" ] }, "dropdownField": { "type": "object", "properties": { "nodeId": { "$ref": "#/definitions/nodeId" }, "type": { "type": "string", "const": "string" }, "title": { "type": "string", "examples": [ "Device Name" ] }, "description": { "type": "string", "examples": [ "A unique name of the target device." ] }, "placeholder": { "type": "string", "examples": [ "Enter the device's name" ] }, "required": { "type": "boolean" }, "enum": { "type": "array", "default": [] }, "binding": { "type": "boolean", "default": false }, "pattern": { "type": "string", "examples": [ "regex" ] }, "rel": { "type": "string", "const": "collection" }, "targetPointer": { "type": "string", "const": "/enum" }, "method": { "type": "string", "examples": [ "GET" ] }, "body": { "type": "object" }, "sourcePointer": { "type": "string", "examples": [ "/" ] }, "sourceKeyPointer": { "type": "string", "examples": [ "/name" ] }, "base": { "type": "string", "examples": [ "http://www.google.com/" ] }, "href": { "type": "string", "examples": [ "api/v1/devices" ] }, "validation": { "type": "object" } }, "required": [ "nodeId", "type", "title", "description" ] } } }