twitch-bot/plugins/action_docs.go
Knut Ahlers 3c00298760
[docs] Allow to comment default value for actor docs
Signed-off-by: Knut Ahlers <knut@ahlers.me>
2023-08-14 16:04:03 +02:00

34 lines
1.3 KiB
Go

package plugins
type (
ActionDocumentation struct {
Description string `json:"description"`
Name string `json:"name"`
Type string `json:"type"`
Fields []ActionDocumentationField `json:"fields"`
}
ActionDocumentationField struct {
Default string `json:"default"`
DefaultComment string `json:"default_comment"`
Description string `json:"description"`
Key string `json:"key"`
Long bool `json:"long"`
Name string `json:"name"`
Optional bool `json:"optional"`
SupportTemplate bool `json:"support_template"`
Type ActionDocumentationFieldType `json:"type"`
}
ActionDocumentationFieldType string
)
const (
ActionDocumentationFieldTypeBool ActionDocumentationFieldType = "bool"
ActionDocumentationFieldTypeDuration ActionDocumentationFieldType = "duration"
ActionDocumentationFieldTypeInt64 ActionDocumentationFieldType = "int64"
ActionDocumentationFieldTypeString ActionDocumentationFieldType = "string"
ActionDocumentationFieldTypeStringSlice ActionDocumentationFieldType = "stringslice"
)