Schema 参考

Toolpad Studio 文件格式的详尽参考。

文件

以下是 toolpad 支持的各种文件。

应用程序

对象

定义此对象的版本。用于确定 Toolpad Studio “应用程序”对象之间的兼容性。

apiVersion: "v1"

描述此 Toolpad Studio “应用程序”对象的性质。

kind: "application"

定义此“应用程序”对象的形状

spec: 对象

此应用程序的计划。

计划: "free" | "pro"

此应用程序的身份验证配置。

身份验证: 对象

要使用的身份验证提供程序。

提供程序: array of object

此身份验证提供程序的唯一标识符。

提供程序: "github" | "google" | "azure-ad" | "credentials"

此身份验证提供程序的角色映射定义。

角色: array of object

要从中映射的身份验证提供程序角色。

源: array of string

要映射到的 Toolpad Studio 角色。

目标: string

已验证用户的有效电子邮件模式。

restrictedDomains: array of string

此应用程序的授权配置。

授权: 对象

此应用程序的可用角色。这些角色可以分配给用户。

角色: array of any of

string
对象
角色的名称。
名称: string
角色的描述。
描述: string

页面

对象

定义此对象的版本。用于确定 Toolpad Studio “页面”对象之间的兼容性。

apiVersion: "v1"

描述此 Toolpad Studio “页面”对象的性质。

kind: "page"

定义此“页面”对象的形状

spec: 对象

要在 UI 中显示的页面名称。

显示名称: string

用作页面的规范 ID。已弃用：请改用别名。

id: string

页面名称别名。

别名: array of string

此页面的标题。

标题: string

页面的参数。这些可以在 url 查询字符串中设置。

参数: array of NameStringValuePair

页面使用的查询。这些将在页面打开时加载数据。

查询: array of object

查询的名称

名称: string

激活或停用查询。停用后，页面打开时不会加载数据。

已启用: 任何一个

boolean
JsExpressionBinding
EnvBinding

要传递给此查询的参数。

参数: 数组

名称/值对。

对象

名称

名称: string

值

值: 任何一个

any
JsExpressionBinding
EnvBinding

如何获取此查询。

模式: 任何一个

页面打开时自动获取
"query"
仅在手动操作时获取
"mutation"

查询定义

查询: 任何一个

对象
将此对象指定为获取查询。
kind: "rest"
请求的 URL
url: 任何一个
string
JsExpressionBinding
EnvBinding
请求方法。
方法: string
额外的请求标头。
标头: array of BindableNameStringValue
额外的 url 查询参数。
searchParams: array of BindableNameStringValue
请求正文。
正文: 任何一个
对象
kind: "raw"
内容: 任何一个
string
JsExpressionBinding
EnvBinding
contentType: string
对象
kind: "urlEncoded"
内容: array of BindableNameStringValue
在响应上运行自定义转换器。
启用转换: boolean
启用时要运行的自定义转换器。
转换: string
如何解析响应。
响应: 任何一个
完全不解释此正文。
对象
kind: "raw"
将获取响应解释为 JSON
对象
kind: "json"
将获取响应解释为 CSV
对象
kind: "csv"
第一行包含标头
标头: boolean
将获取响应解释为 XML
对象
kind: "xml"
对象
将此对象指定为本地函数查询。
kind: "local"
要由此查询在后端执行的函数。
函数: string