用户输入

每个操作的定义中都有一个 "userInputs "部分，在这部分中，您可以定义您希望开发人员和用户在调用操作时填写的所有用户输入信息。

结构

{
  "properties": {
    "myInput": {
      "title": "My input",
      "icon": "My icon",
      "description": "My input",
      "type": "input_type"
    }
  },
  "required": ["myInput"]
}

下表列出了构成基本用户输入定义的不同组件:

Field	Description
title	Input title
type	Mandatory field. The data type of the input.
icon	Icon for the input See the full icon list.
description	Description of the input. This value is visible to users when hovering on the info icon in the UI. It provides detailed information about the use of a specific input or the way it will be used.
default	Default value for this input in case the self-service action will be executed without explicitly providing a value.

属性结构 输入名称是输入对象的键。 例如，在上面的代码块中，输入名称是 myInput 。

请注意，所有可用于 Port 蓝图的properties 也可被用作用户输入，这就是为什么它们遵循相同的结构。

支持的用户输入

📄️ 文本

文本文本是文本信息的基本输入

📄️ 编号

数字Number 是数字数据的基本输入法

📄️ 布尔型

布尔值布尔值是一种基本输入法，它有两种可能的值--true 和 false 其中之一

📄️ 对象

对象是 JSON 数据的基本输入

📄️ 数组

数组是数据列表的输入端

📄️ URL

URL 是用于保存网站链接的输入法

📄️ 电子邮件

电子邮件是用于保存电子邮件地址的输入法

📄️ 用户

用户User 是一个输入，用于引用存在于 Port 中的用户。

📄️ 团队

团队是用于引用 Port 中存在的团队的输入信息。

📄️ 日期时间

Datetime 是用于引用日期和时间的输入法

📄️ Yaml

Yaml 是一种输入法，被用于用于以 YAML 保存对象定义

📄️ 实体

实体实体是一种输入，用于在触发操作时引用软件目录中的现有实体

📄️ Secret

Secret 是一种输入法，其值在发送到后端时会用客户secret加密，在其传输过程中绝不会保存或记录。

排序用户输入

您可以使用 order 字段定义用户界面中显示用户输入的顺序。 该字段是一个包含用户输入名称的数组。

{
  "properties": {
    "myInput1": {
      "title": "My input 1",
      "icon": "My icon 1",
      "description": "My input 1",
      "type": "input_type"
    },
    "myInput2": {
      "title": "My input 2",
      "icon": "My icon 2",
      "description": "My input 2",
      "type": "input_type"
    }
  },
  "required": [],
  "order": ["myInput2", "myInput1"]
}