📝 生成了api文档
This commit is contained in:
@ -9,52 +9,57 @@ category: API
|
||||
|
||||
插件类型枚举值
|
||||
|
||||
####   ***attr*** `APPLICATION`
|
||||
###   ***attr*** `APPLICATION: 'application'`
|
||||
|
||||
Type: 'application'
|
||||
###   ***attr*** `SERVICE: 'service'`
|
||||
|
||||
####   ***attr*** `SERVICE`
|
||||
###   ***attr*** `IMPLEMENTATION: 'implementation'`
|
||||
|
||||
Type: 'service'
|
||||
###   ***attr*** `MODULE: 'module'`
|
||||
|
||||
####   ***attr*** `IMPLEMENTATION`
|
||||
|
||||
Type: 'implementation'
|
||||
|
||||
####   ***attr*** `MODULE`
|
||||
|
||||
Type: 'module'
|
||||
|
||||
####   ***attr*** `UNCLASSIFIED`
|
||||
|
||||
Type: 'unclassified'
|
||||
###   ***attr*** `UNCLASSIFIED: 'unclassified'`
|
||||
|
||||
### ***class*** `PluginMetadata(BaseModel)`
|
||||
|
||||
轻雪插件元数据,由插件编写者提供,name为必填项
|
||||
|
||||
Attributes:
|
||||
|
||||
----------
|
||||
|
||||
|
||||
|
||||
name: str
|
||||
|
||||
插件名称
|
||||
|
||||
description: str
|
||||
|
||||
插件描述
|
||||
|
||||
usage: str
|
||||
|
||||
插件使用方法
|
||||
|
||||
type: str
|
||||
|
||||
插件类型
|
||||
|
||||
author: str
|
||||
|
||||
插件作者
|
||||
|
||||
homepage: str
|
||||
|
||||
插件主页
|
||||
|
||||
extra: dict[str, Any]
|
||||
|
||||
额外信息
|
||||
|
||||
### ***class*** `Plugin(BaseModel)`
|
||||
|
||||
存储插件信息
|
||||
|
||||
####   ***attr*** `model_config`
|
||||
|
||||
Type: {'arbitrary_types_allowed': True}
|
||||
###   ***attr*** `model_config: {'arbitrary_types_allowed': True}`
|
||||
|
||||
|
Reference in New Issue
Block a user