chore: comments

This commit is contained in:
Fu Diwei 2024-11-25 21:22:20 +08:00
parent 124af0b76d
commit 2b93552d1d
17 changed files with 61 additions and 19 deletions

View File

@ -11,7 +11,10 @@ import (
) )
type BarkNotifierConfig struct { type BarkNotifierConfig struct {
// Bark 服务地址。
// 零值时默认使用官方服务器。
ServerUrl string `json:"serverUrl"` ServerUrl string `json:"serverUrl"`
// Bark 设备密钥。
DeviceKey string `json:"deviceKey"` DeviceKey string `json:"deviceKey"`
} }

View File

@ -10,8 +10,10 @@ import (
) )
type DingTalkNotifierConfig struct { type DingTalkNotifierConfig struct {
// 钉钉机器人的 Token。
AccessToken string `json:"accessToken"` AccessToken string `json:"accessToken"`
Secret string `json:"secret"` // 钉钉机器人的 Secret。
Secret string `json:"secret"`
} }
type DingTalkNotifier struct { type DingTalkNotifier struct {

View File

@ -13,12 +13,20 @@ import (
) )
type EmailNotifierConfig struct { type EmailNotifierConfig struct {
SmtpHost string `json:"smtpHost"` // SMTP 服务器地址。
SmtpPort int32 `json:"smtpPort"` SmtpHost string `json:"smtpHost"`
SmtpTLS bool `json:"smtpTLS"` // SMTP 服务器端口。
Username string `json:"username"` // 零值时根据是否启用 TLS 决定。
Password string `json:"password"` SmtpPort int32 `json:"smtpPort"`
SenderAddress string `json:"senderAddress"` // 是否启用 TLS。
SmtpTLS bool `json:"smtpTLS"`
// 用户名。
Username string `json:"username"`
// 密码。
Password string `json:"password"`
// 发件人邮箱。
SenderAddress string `json:"senderAddress"`
// 收件人邮箱。
ReceiverAddress string `json:"receiverAddress"` ReceiverAddress string `json:"receiverAddress"`
} }

View File

@ -10,6 +10,7 @@ import (
) )
type LarkNotifierConfig struct { type LarkNotifierConfig struct {
// 飞书 Webhook 地址。
WebhookUrl string `json:"webhookUrl"` WebhookUrl string `json:"webhookUrl"`
} }

View File

@ -11,6 +11,7 @@ import (
) )
type ServerChanNotifierConfig struct { type ServerChanNotifierConfig struct {
// ServerChan 服务地址。
Url string `json:"url"` Url string `json:"url"`
} }

View File

@ -10,8 +10,10 @@ import (
) )
type TelegramNotifierConfig struct { type TelegramNotifierConfig struct {
// Telegram API Token。
ApiToken string `json:"apiToken"` ApiToken string `json:"apiToken"`
ChatId int64 `json:"chatId"` // Telegram Chat ID。
ChatId int64 `json:"chatId"`
} }
type TelegramNotifier struct { type TelegramNotifier struct {

View File

@ -10,6 +10,7 @@ import (
) )
type WebhookNotifierConfig struct { type WebhookNotifierConfig struct {
// Webhook URL。
Url string `json:"url"` Url string `json:"url"`
} }

View File

@ -17,9 +17,12 @@ import (
) )
type AliyunCASUploaderConfig struct { type AliyunCASUploaderConfig struct {
AccessKeyId string `json:"accessKeyId"` // 阿里云 AccessKeyId。
AccessKeyId string `json:"accessKeyId"`
// 阿里云 AccessKeySecret。
AccessKeySecret string `json:"accessKeySecret"` AccessKeySecret string `json:"accessKeySecret"`
Region string `json:"region"` // 阿里云地域。
Region string `json:"region"`
} }
type AliyunCASUploader struct { type AliyunCASUploader struct {

View File

@ -20,9 +20,12 @@ import (
) )
type AliyunSLBUploaderConfig struct { type AliyunSLBUploaderConfig struct {
AccessKeyId string `json:"accessKeyId"` // 阿里云 AccessKeyId。
AccessKeyId string `json:"accessKeyId"`
// 阿里云 AccessKeySecret。
AccessKeySecret string `json:"accessKeySecret"` AccessKeySecret string `json:"accessKeySecret"`
Region string `json:"region"` // 阿里云地域。
Region string `json:"region"`
} }
type AliyunSLBUploader struct { type AliyunSLBUploader struct {

View File

@ -19,7 +19,9 @@ import (
) )
type ByteplusCDNUploaderConfig struct { type ByteplusCDNUploaderConfig struct {
// BytePlus AccessKey。
AccessKey string `json:"accessKey"` AccessKey string `json:"accessKey"`
// BytePlus SecretKey。
SecretKey string `json:"secretKey"` SecretKey string `json:"secretKey"`
} }

View File

@ -13,7 +13,9 @@ import (
) )
type DogeCloudUploaderConfig struct { type DogeCloudUploaderConfig struct {
// 多吉云 AccessKey。
AccessKey string `json:"accessKey"` AccessKey string `json:"accessKey"`
// 多吉云 SecretKey。
SecretKey string `json:"secretKey"` SecretKey string `json:"secretKey"`
} }

View File

@ -22,9 +22,12 @@ import (
) )
type HuaweiCloudELBUploaderConfig struct { type HuaweiCloudELBUploaderConfig struct {
AccessKeyId string `json:"accessKeyId"` // 华为云 AccessKeyId。
AccessKeyId string `json:"accessKeyId"`
// 华为云 SecretAccessKey。
SecretAccessKey string `json:"secretAccessKey"` SecretAccessKey string `json:"secretAccessKey"`
Region string `json:"region"` // 华为云地域。
Region string `json:"region"`
} }
type HuaweiCloudELBUploader struct { type HuaweiCloudELBUploader struct {

View File

@ -18,9 +18,12 @@ import (
) )
type HuaweiCloudSCMUploaderConfig struct { type HuaweiCloudSCMUploaderConfig struct {
AccessKeyId string `json:"accessKeyId"` // 华为云 AccessKeyId。
AccessKeyId string `json:"accessKeyId"`
// 华为云 SecretAccessKey。
SecretAccessKey string `json:"secretAccessKey"` SecretAccessKey string `json:"secretAccessKey"`
Region string `json:"region"` // 华为云地域。
Region string `json:"region"`
} }
type HuaweiCloudSCMUploader struct { type HuaweiCloudSCMUploader struct {

View File

@ -15,7 +15,9 @@ import (
) )
type QiniuSSLCertUploaderConfig struct { type QiniuSSLCertUploaderConfig struct {
// 七牛云 AccessKey。
AccessKey string `json:"accessKey"` AccessKey string `json:"accessKey"`
// 七牛云 SecretKey。
SecretKey string `json:"secretKey"` SecretKey string `json:"secretKey"`
} }

View File

@ -13,7 +13,9 @@ import (
) )
type TencentCloudSSLUploaderConfig struct { type TencentCloudSSLUploaderConfig struct {
SecretId string `json:"secretId"` // 腾讯云 SecretId。
SecretId string `json:"secretId"`
// 腾讯云 SecretKey。
SecretKey string `json:"secretKey"` SecretKey string `json:"secretKey"`
} }

View File

@ -19,7 +19,9 @@ import (
) )
type VolcEngineCDNUploaderConfig struct { type VolcEngineCDNUploaderConfig struct {
AccessKeyId string `json:"accessKeyId"` // 火山引擎 AccessKeyId。
AccessKeyId string `json:"accessKeyId"`
// 火山引擎 AccessKeySecret。
AccessKeySecret string `json:"accessKeySecret"` AccessKeySecret string `json:"accessKeySecret"`
} }

View File

@ -16,7 +16,9 @@ import (
) )
type VolcEngineLiveUploaderConfig struct { type VolcEngineLiveUploaderConfig struct {
AccessKeyId string `json:"accessKeyId"` // 火山引擎 AccessKeyId。
AccessKeyId string `json:"accessKeyId"`
// 火山引擎 AccessKeySecret。
AccessKeySecret string `json:"accessKeySecret"` AccessKeySecret string `json:"accessKeySecret"`
} }