📝 update doc

This commit is contained in:
yanyongyu
2021-02-05 13:31:33 +08:00
parent f929f25abd
commit ff9f0bc74a
16 changed files with 282 additions and 57 deletions

View File

@ -5,6 +5,14 @@ from pydantic import Field, BaseModel
# priority: alias > origin
class Config(BaseModel):
"""
CQHTTP 配置类
:配置项:
- ``access_token`` / ``cqhttp_access_token``: CQHTTP 协议授权令牌
- ``secret`` / ``cqhttp_secret``: CQHTTP HTTP 上报数据签名口令
"""
access_token: Optional[str] = Field(default=None,
alias="cqhttp_access_token")
secret: Optional[str] = Field(default=None, alias="cqhttp_secret")

View File

@ -4,6 +4,14 @@ from pydantic import Field, BaseModel
class Config(BaseModel):
"""
钉钉配置类
:配置项:
- ``access_token`` / ``ding_access_token``: 钉钉令牌
- ``secret`` / ``ding_secret``: 钉钉 HTTP 上报数据签名口令
"""
secret: Optional[str] = Field(default=None, alias="ding_secret")
access_token: Optional[str] = Field(default=None, alias="ding_access_token")

View File

@ -10,9 +10,9 @@ class Config(BaseModel):
:必填:
- ``mirai_auth_key``: mirai-api-httpauth_key
- ``mirai_host``: mirai-api-http的地址
- ``mirai_port``: mirai-api-http的端口
- ``auth_key`` / ``mirai_auth_key``: mirai-api-httpauth_key
- ``mirai_host``: mirai-api-http 的地址
- ``mirai_port``: mirai-api-http 的端口
"""
auth_key: Optional[str] = Field(None, alias='mirai_auth_key')
host: Optional[IPv4Address] = Field(None, alias='mirai_host')