feat(config): comment var in config.yml (#90)

release-argus · Jun 15, 2022 · 95c332c · 95c332c
1 parent 8606bbf
commit 95c332c
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 3 deletions.
diff --git a/service/types.go b/service/types.go
@@ -30,7 +30,8 @@ type Slice map[string]*Service
 // the latest version from the URL provided.
 type Service struct {
 	ID                    *string                `yaml:"-"`                             // service_name.
-	Active                *bool                  `yaml:"active,omitempty"`              // Disable the service
+	Active                *bool                  `yaml:"active,omitempty"`              // Disable the service.
+	Comment               *string                `yaml:"comment,omitempty"`             // Comment on the Service.
 	Type                  *string                `yaml:"type,omitempty"`                // "github"/"URL"
 	URL                   *string                `yaml:"url,omitempty"`                 // type:URL - "https://example.com", type:github - "owner/repo" or "https://github.com/owner/repo".
 	AllowInvalidCerts     *bool                  `yaml:"allow_invalid_certs,omitempty"` // default - false = Disallows invalid HTTPS certificates.

diff --git a/web/api/types/argus.go b/web/api/types/argus.go
@@ -23,8 +23,9 @@ import (
 
 // ServiceSummary is the Summary of a Service.
 type ServiceSummary struct {
-	Active                   *bool   `json:"active,omitempty"` // Active Service?
-	ID                       *string `json:"id"`
+	ID                       *string `json:"id,omitempty"`                   //
+	Active                   *bool   `json:"active,omitempty"`               // Active Service?
+	Comment                  *string `json:"comment,omitempty"`              // Comment on the Service/
 	Type                     *string `json:"type,omitempty"`                 // "github"/"URL"
 	URL                      *string `json:"url,omitempty"`                  // type:URL - "https://example.com", type:github - "owner/repo" or "https://github.com/owner/repo".
 	Icon                     string  `json:"icon,omitempty"`                 // Service.Icon / Service.Notify.*.Params.Icon / Service.Notify.*.Defaults.Params.Icon
@@ -242,6 +243,7 @@ type ServiceSlice map[string]*Service
 // the latest version from the URL provided.
 type Service struct {
 	Active                *bool                  `json:"active,omitempty"`              // Active Service?
+	Comment               *string                `json:"comment,omitempty"`             // Comment on the Service/
 	Type                  *string                `json:"type,omitempty"`                // "github"/"URL"
 	URL                   *string                `json:"url,omitempty"`                 // type:URL - "https://example.com", type:github - "owner/repo" or "https://github.com/owner/repo".
 	WebURL                *string                `json:"web_url,omitempty"`             // URL to provide on the Web UI

diff --git a/web/api/v1/websocket.go b/web/api/v1/websocket.go
@@ -512,6 +512,7 @@ func (api *API) wsConfigService(client *Client) {
 
 			serviceConfig[key] = &api_types.Service{
 				Active:             service.Active,
+				Comment:            service.Comment,
 				Type:               service.Type,
 				URL:                service.URL,
 				WebURL:             service.WebURL,

diff --git a/web/ui/react-app/src/types/config.tsx b/web/ui/react-app/src/types/config.tsx
@@ -43,6 +43,7 @@ export interface ServiceListType {
 
 export interface ServiceType {
   active?: boolean;
+  comment?: string;
   type: string;
   url?: string;
   allow_invalid_certs?: boolean;