Action's JsonShema

Action's JsonShema :::info what is JsonSchema？ ::: InputJsonSchema OutputJsonSchema JsonSchema Schema PropertiesSchema PropertySchema UiSchema SubUiSchema UiOptions InputJsonSchema

what is JsonSchema？

InputJsonSchema

Declares the data structure and page structure of the robot action input.

Details

Type: JsonSchema

Example

{
    "schema":{
        "type":"object",
        "required":[
            "account",
            "password"
        ],
        "properties":{
            "account":{
                "type":"string",
                "title":"Account"
            },
            "password":{
                "type":"string",
                "title":"Password"
            }
        }
    },
    "uiSchema":{
        "ui:order":[
            "account",
            "password"
        ]
    }
}

OutputJsonSchema

Declares the data structure and page structure of the robot action output.

Details

Type: JsonSchema

Example

{
    "schema":{
        "type":"object",
        "required":[
            "message"
        ],
        "properties":{
            "message":{
                "type":"string",
                "title":"Action execution result"
            }
        }
    },
    "uiSchema":{
        "ui:order":[
            "message"
        ]
    }
}

JsonSchema

We use it to define the data structure and page structure of the robot action input and output.

Details

Type: object

Properties

Key	Required	Type	Description
schema	yes	Schema	Declares the data structure of the robot action input and output.
uiSchema	yes	UiSchema	Declares the page structure of the robot action input and output.

Example:

{"schema": {"type": "object", "required": ["account", "password" ], "properties": {"account": { "type": "string", "title": "Account"}, "password": {"type": "string", "title": "Password"}}}, "uiSchema": {"ui:order": ["account", "password"]}}
{"schema": {"type": "object", "required": ["message"], "properties": {"message": {"type": "string", "title": "Action execution result"}}}, "uiSchema": { "ui:order": ["message"]}}

Schema

Declares the data structure of the robot action input and output

Details

Type: object

Properties

Key	Required	Type	Description
type	yes	string in ('object')	This key-value pair is fixed.
properties	yes	PropertiesSchema	Declares the properties of the robot action input and output data structure.
required	no	array	Declares the keys of the properties that must exist in the robot action input and output values.

Example

{"type": "object", "required": ["account", "password" ], "properties": { "account": {"type": "string", "title": "Account" }, "password": {"type": "string", "title": "Password"}}
{"type": "object", "required": ["fruit"], "properties": {"fruit": { "type": "string", "title": "Fruit", "enum": ["apple", "pear", "orange"], "default": "apple" }}}

PropertiesSchema

Declares the information of the properties in the robot action input and output data structure.

Details

Type: object

Properties

Key	Required	Type	Description
`[^\s]+`	no	PropertySchema	The key needs to be a string.

Example

{"account": {"type": "string", "title": "Account" }, "password": {"type": "string", "title": "Password"}}
{"fruit": {"type": "string", "title": "Fruit", "enum": ["apple", "pear", "orange"], "default": "apple" }}

PropertySchema

Declares the information of a property.

Details

Type: object

Properties

Key	Required	Type	Description
type	yes	string in ('string', 'array', 'object')	string in ('string', 'array', 'object')The type of the property.
title	yes	string	The name of the property.
description	no	string	The description of the property.
enum	no	array	When the property type is string, specifies the possible values.
default	no	string	When the property type is string, specifies the default value.

Example

{"type": "string", "title": "Account"}
{"type": "string", "title": "Fruit", "enum": ["apple", "pear", "orange"], "default": "apple"}

UiSchema

Used to declare the UI of JSON data.

Details

Type: object

Properties

Key	Required	Type	Description
ui	no	array	Specifies the order in which properties are displayed on the UI.
key of PropertiesSchema	no	SubUiSchema	The key is the property key.

Example

{"ui:order": [ "account", "password"]}

SubUiSchema

Specifies the UI style of a property.

Details

Type: object

Properties

Key	Required	Type	Description
ui	no	UiOptions	Specifies some styles when rendering a property.
ui	no	string	Specifies the name of the component used to render a property.
ui	no	array	Specifies the order in which property components are displayed on the page.。
key of PropertiesSchema	no	SubUiSchema	The key is the property key.

UiOptions

Specifies some styles when rendering a property.

Details

Type: object

Properties

Key	Required	Type	Description
showTitle	no	boolean	Whether to display the title.

Action's JsonShema

On this page