Files
crawlab/core/models/models/notification_request.go
Marvin Zhang 931a36c8bf refactor: enhance parameter descriptions and standardize model fields
- Added descriptive annotations to various parameters across controllers to improve API documentation clarity.
- Standardized field definitions in models by including descriptions for better understanding of their purpose.
- Updated validation patterns for ID fields to ensure consistency and improve data integrity.
- Enhanced overall code readability and maintainability by aligning naming conventions and adding necessary comments.
2025-03-19 13:39:02 +08:00

23 lines
1.5 KiB
Go

package models
import "go.mongodb.org/mongo-driver/bson/primitive"
type NotificationRequest struct {
any `collection:"notification_requests"`
BaseModel `bson:",inline"`
Status string `json:"status" bson:"status" description:"Status"`
Error string `json:"error,omitempty" bson:"error,omitempty" description:"Error"`
Title string `json:"title" bson:"title" description:"Title"`
Content string `json:"content" bson:"content" description:"Content"`
SenderEmail string `json:"sender_email,omitempty" bson:"sender_email,omitempty" description:"Sender email"`
SenderName string `json:"sender_name,omitempty" bson:"sender_name,omitempty" description:"Sender name"`
MailTo []string `json:"mail_to,omitempty" bson:"mail_to,omitempty" description:"Mail to"`
MailCc []string `json:"mail_cc,omitempty" bson:"mail_cc,omitempty" description:"Mail CC"`
MailBcc []string `json:"mail_bcc,omitempty" bson:"mail_bcc,omitempty" description:"Mail BCC"`
SettingId primitive.ObjectID `json:"setting_id" bson:"setting_id" description:"Setting ID"`
ChannelId primitive.ObjectID `json:"channel_id" bson:"channel_id" description:"Channel ID"`
Setting *NotificationSetting `json:"setting,omitempty" bson:"-" binding:"-"`
Channel *NotificationChannel `json:"channel,omitempty" bson:"-" binding:"-"`
Test bool `json:"test,omitempty" bson:"test,omitempty" description:"Test"`
}