root.composeExtensions.commands.parameters.choices object

The choice options for the parameter. Use only when parameters.inputType is choiceset.

Properties that reference this object type:

• root.composeExtensions.commands.parameters.choices

Syntax

Syntax

{
  "title": "{string}",
  "value": "{string}"
}

Schema

{
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "description": "Title of the choice",
      "maxLength": 128
    },
    "value": {
      "type": "string",
      "description": "Value of the choice",
      "maxLength": 512
    }
  },
  "additionalProperties": false,
  "required": [
    "title",
    "value"
  ]
}

Properties

title

Title of the choice.

Type
string

Required
✅

Constraints
Maximum string length: 128.

Supported values

value

Value of the choice.

Type
string

Required
✅

Constraints
Maximum string length: 512.

Supported values

Examples

{
"composeExtensions": [
        {
            "commands": [
                {
                    "parameters": [
                        {
                            "choices": [
                                {
                                    "title": "Title of the choice",
                                    "value": "Value of the choice"
                                }
                            ]
                        }
                    ]
                },
            ],
        }
    ]
}