模板管理相关接口
/api/v1/templates¶
POST¶
Summary:¶
创建模板
Description:¶
创建模板
Parameters¶
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| data | body | data | Yes | dto.TemplateInsertReq |
Responses¶
| Code | Description | Schema |
|---|---|---|
| 200 | {"code": 200, "message": "success"} | response.Response |
Security¶
| Security Schema | Scopes |
|---|---|
| Bearer |
DELETE¶
Summary:¶
删除模板
Description:¶
删除模板
Parameters¶
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| data | body | uids | No | dto.TemplateDeleteReq |
Responses¶
| Code | Description | Schema |
|---|---|---|
| 200 | {"code": 200, "message": "success"} | response.Response |
Security¶
| Security Schema | Scopes |
|---|---|
| Bearer |
GET¶
Summary:¶
查询模板列表
Description:¶
查询模板列表
Parameters¶
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| page | query | 页条数 | No | integer |
| limit | query | 页码 | No | integer |
Responses¶
| Code | Description | Schema |
|---|---|---|
| 200 | {"code": 200, "data": [...]} | response.Response & object |
Security¶
| Security Schema | Scopes |
|---|---|
| Bearer |
/api/v1/templates/{uid}¶
GET¶
Summary:¶
查询模板
Description:¶
查询模板
Parameters¶
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| templateID | path | uid | No | string |
Responses¶
| Code | Description | Schema |
|---|---|---|
| 200 | {"code": 200, "data": [...]} | response.Response & object |
Security¶
| Security Schema | Scopes |
|---|---|
| Bearer |
PUT¶
Summary:¶
更新模板
Description:¶
更新模板
Parameters¶
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| data | body | body | Yes | dto.TemplateUpdateReq |
Responses¶
| Code | Description | Schema |
|---|---|---|
| 200 | {"code": 200, "message": "success"} | response.Response |
Security¶
| Security Schema | Scopes |
|---|---|
| Bearer |
dto.TemplateDeleteReq¶
| Name | Type | Description | Required |
|---|---|---|---|
| uids | [ string ] | No |
dto.TemplateInsertReq¶
| Name | Type | Description | Required |
|---|---|---|---|
| description | string | No | |
| displayName | string | No | |
| scene | integer | 模板类别 转码 | 音频 |
| spec | [ integer ] | 回调内容 JSON Plain Object 格式 | No |
| type | integer | 模板类型 系统内置 | 用户定义 |
| workflow | [ integer ] | 回调内容 JSON Plain Object 格式 | No |
dto.TemplateMetaDeleteReq¶
| Name | Type | Description | Required |
|---|---|---|---|
| uids | [ string ] | No |
dto.TemplateMetaInsertReq¶
| Name | Type | Description | Required |
|---|---|---|---|
| description | string | No | |
| displayName | string | No | |
| scene | integer | 模板类别 转码 | 音频 |
| spec | [ integer ] | 回调内容 JSON Plain Object 格式 | No |
| type | integer | 模板类型 系统预置 | 用户定义 |
| workflow | [ integer ] | 回调内容 JSON Plain Object 格式 | No |
dto.TemplateMetaUpdateReq¶
| Name | Type | Description | Required |
|---|---|---|---|
| description | string | No | |
| displayName | string | No | |
| scene | integer | 模板类别 转码 | 音频 |
| spec | [ integer ] | 回调内容 JSON Plain Object 格式 | No |
| type | integer | 模板类型 系统预置 | 用户定义 |
| uid | string | No | |
| workflow | [ integer ] | 回调内容 JSON Plain Object 格式 | No |
dto.TemplateUpdateReq¶
| Name | Type | Description | Required |
|---|---|---|---|
| description | string | No | |
| displayName | string | No | |
| scene | integer | 模板类别 转码 | 音频 |
| spec | [ integer ] | 回调内容 JSON Plain Object 格式 | No |
| type | integer | 模板类型 系统内置 | 用户定义 |
| uid | string | No | |
| workflow | [ integer ] | 回调内容 JSON Plain Object 格式 | No |
models.TemplateRecord¶
| Name | Type | Description | Required |
|---|---|---|---|
| createdAt | models.LocalTime | No | |
| description | string | 模板描述 | No |
| displayName | string | 模板名称 | No |
| scene | integer | 模板类别 转码 | 音频 |
| spec | [ integer ] | 回调内容 JSON Plain Object 格式 | No |
| type | integer | 模板类型 系统内置 | 用户定义 |
| uid | string | 唯一uuid | No |
| updatedAt | models.LocalTime | No | |
| workflow | [ integer ] | 回调内容 JSON Plain Object 格式 | No |