chore(controller-sdk-go): fmt go code

Author: duanhongyi

allowlist/allowlist_test.go

@@ -31,7 +31,6 @@ func (fakeHTTPServer) ServeHTTP(res http.ResponseWriter, req *http.Request) {
 
 	if req.URL.Path == "/v2/apps/example-go/allowlist/" && req.Method == "POST" {
 		body, err := io.ReadAll(req.Body)
-
 		if err != nil {
 			fmt.Println(err)
 			res.WriteHeader(http.StatusInternalServerError)
@@ -89,7 +88,6 @@ func TestAllowlistList(t *testing.T) {
 	}
 
 	actual, err := List(drycc, "example-go")
-
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -116,7 +114,6 @@ func TestAllowlistAdd(t *testing.T) {
 	}
 
 	actual, err := Add(drycc, "example-go", []string{"1.2.3.4", "0.0.0.0/0"})
-
 	if err != nil {
 		t.Fatal(err)
 	}

api/apps.go

@@ -1,3 +1,4 @@
+// Package api provides data structures for the Drycc Controller API.
 package api
 
 // App is the definition of the app object.

api/auth.go

@@ -1,10 +1,12 @@
 package api
 
+// AuthLoginRequest represents the request structure for authentication login.
 type AuthLoginRequest struct {
 	Username string `json:"username,omitempty"`
 	Password string `json:"password,omitempty"`
 }
 
+// AuthLoginResponse represents the response structure for authentication login.
 type AuthLoginResponse struct {
 	Key string `json:"key,omitempty"`
 }

api/config.go

@@ -9,23 +9,26 @@ import (
 // ConfigTags is the key, value for tag
 type ConfigTags map[string]interface{}
 
-// ConfigValues value for env
+// ConfigVar represents a configuration variable for an app.
 type ConfigVar struct {
 	Name  string      `json:"name"`
 	Value interface{} `json:"value"`
 }
 
+// ConfigValue represents a configuration value with its type and group.
 type ConfigValue struct {
 	Ptype string `json:"ptype,omitempty"`
 	Group string `json:"group,omitempty"`
 	ConfigVar
 }
 
+// PtypeValue represents values for a specific process type.
 type PtypeValue struct {
 	Env []ConfigVar `json:"env,omitempty"`
 	Ref []string    `json:"ref,omitempty"`
 }
 
+// ConfigInfo represents the complete configuration information for an app.
 type ConfigInfo struct {
 	Ptype map[string]PtypeValue  `json:"ptype,omitempty"`
 	Group map[string][]ConfigVar `json:"group,omitempty"`

api/events.go

@@ -1,10 +1,11 @@
 package api
 
-// Event defines the structure of event.
+// AppEvent represents an event in the system.
 type AppEvent struct {
 	Reason  string `json:"reason"`
 	Message string `json:"message"`
 	Created string `json:"created"`
 }
 
+// AppEvents is a collection of AppEvent.
 type AppEvents []AppEvent

api/filer.go

@@ -1,5 +1,6 @@
 package api
 
+// FilerDirEntry represents a directory entry in the file system.
 type FilerDirEntry struct {
 	Name      string `json:"name,omitempty"`
 	Path      string `json:"path,omitempty"`
@@ -8,4 +9,5 @@ type FilerDirEntry struct {
 	Timestamp string `json:"timestamp,omitempty"`
 }
 
+// FilerDirEntries is a collection of FilerDirEntry.
 type FilerDirEntries []FilerDirEntry

api/gateways.go

@@ -18,13 +18,15 @@ type Gateway struct {
 	Addresses []Address  `json:"addresses,omitempty"`
 }
 
+// Listener represents a gateway listener configuration.
 type Listener struct {
 	Name          string      `json:"name,omitempty"`
 	Port          int         `json:"port,omitempty"`
 	Protocol      string      `json:"protocol,omitempty"`
 	AllowedRoutes interface{} `json:"allowedRoutes,omitempty"`
 }
 
+// Address represents a gateway address configuration.
 type Address struct {
 	Type  string `json:"type,omitempty"`
 	Value string `json:"value,omitempty"`
@@ -40,7 +42,7 @@ type GatewayCreateRequest struct {
 	Protocol string `json:"protocol,omitempty"`
 }
 
-// GatewayRemoteRequest is the structure of Delete /v2/app/<app id>/gateways/.
+// GatewayRemoveRequest is the structure of Delete /v2/app/<app id>/gateways/.
 type GatewayRemoveRequest struct {
 	Name     string `json:"name,omitempty"`
 	Port     int    `json:"port,omitempty"`

api/ps.go

@@ -40,15 +40,15 @@ type PodType struct {
 // PodTypes holds groups of pods organized by type.
 type PodTypes []PodType
 
-// AppLogsRequest is the definition of websocket /v2/apps/<app id>/logs
+// PodLogsRequest is the definition of websocket /v2/apps/<app id>/logs
 type PodLogsRequest struct {
 	Lines     int    `json:"lines"`
 	Follow    bool   `json:"follow"`
 	Container string `json:"container"`
 	Previous  bool   `json:"previous"`
 }
 
-// Start is the definition of POST /v2/apps/<app_id>/stop or POST /v2/apps/<app_id>/start.
+// Types is the definition of POST /v2/apps/<app_id>/stop or POST /v2/apps/<app_id>/start.
 type Types struct {
 	Types []string `json:"types,omitempty"`
 }
@@ -75,6 +75,7 @@ type ContainerState struct {
 // PodState defines a collection of container state.
 type PodState []ContainerState
 
+// PodIDs represents a list of pod IDs.
 type PodIDs struct {
 	PodIDs string `json:"pod_ids"`
 }

api/pts.go

@@ -32,10 +32,11 @@ type PtypeState struct {
 	NodeSelector   map[string]string `json:"node_selector,omitempty"`
 }
 
+// VolumeMount represents a volume mount in a container.
 type VolumeMount struct {
 	Name      string `json:"name"`
 	MountPath string `json:"mountPath"`
 }
 
-// PtypesState defines a collection of container state.
+// PtypeStates defines a collection of container state.
 type PtypeStates []PtypeState

api/releases.go

@@ -22,6 +22,7 @@ type ReleaseRollback struct {
 	Ptypes  string `json:"ptypes"`
 }
 
+// Condition represents a condition in a release.
 type Condition struct {
 	State     string   `json:"state"`
 	Action    string   `json:"action"`