Message Schema#

anyOf

any message

any content#

type

object / string / number / boolean / array / null

any message#

anyOf

any request

any response

any message type#

anyOf

message type run

message type app info

any request#

anyOf

app info request

run request

any response#

anyOf

any valid response

error response

any valid response#

anyOf

app info response

run response

app info#

type

object

properties

  • commands

commands info

  • name

type

string

  • plugins

type

array

items

type

string

  • title

type

string

  • url

type

string

  • version

type

string

additionalProperties

False

command info#

type

object

properties

  • caption

type

string

  • className

type

string

  • dataset

type

object

  • icon

type

string / null

  • iconClass

type

string

  • iconLabel

type

string

  • isEnabled

type

boolean

  • isToggleable

type

boolean

  • isToggled

type

boolean

  • isVisible

type

boolean

  • label

type

string

  • mnemonic

type

string / number

  • usage

type

string

additionalProperties

False

commands info#

type

object

additionalProperties

command info

app info request#

type

object

properties

  • content

any content

  • request_id

type

string

  • request_type

message type app info

additionalProperties

False

app info response#

type

object

properties

  • content

app info

  • request_id

type

string

  • request_type

message type app info

additionalProperties

False

error response#

type

object

properties

  • error

type

string

  • request_id

type

string

  • request_type

any message type

additionalProperties

False

run request#

type

object

properties

  • content

run request content

  • request_id

type

string

  • request_type

message type run

additionalProperties

False

run response#

type

object

properties

  • content

any content

  • request_id

type

string

  • request_type

message type app info

additionalProperties

False

message type app info#

type

string

const

app_info

message type run#

type

string

const

run

run request content#

type

object

properties

  • args

type

object

  • id

type

string

additionalProperties

False