自定义动作元数据

这个库提供了类型和json schema,用于工作并验证自定义动作元数据.

更多关于自定义动作 开发者门户网站。 。 。 .

使用量

定义自定义动作的元数据 :

import { CustomActionMetadata } from '@bryter_io/custom-actions'
const metadata: CustomActionMetadata = {
  key: 'echo-action',
  developerEmail: '[email protected]',
  name: 'Echo action',
  description: 'Takes a string and returns it',
  parameters: [{
    type: 'text',
    name: 'Input string',
    description: 'Text to echo back'
  }],
  result: {
    type: 'text',
    description: 'Text echoed back'
  }
}

您可以在网站上找到更多代码样本 开发者门户网站。 。 。 .

安装

npm install --save @bryter_io/custom-actions

* 在当地工作

测试

npm test

npm run lint

验证 JSON 计划

用于验证自定义动作元数据的 JSON 计划载于 custom-actions-schema.json 文档。 此文件被API用于验证发送给后端的元数据.

本地验证单个文件可以通过命令行进行 :

# validate JSON schema
npm run validate-metadata ./path/to/file.json 

💡 此命令需要有 npx 数据 全球安装.