Switch sync was not decoupled from internal data.

Also fixes optional result parameters for switch sync struct, which is breaking the swagger response validation.
metal-stack · Sep 22, 2020 · b54dedd · b54dedd
1 parent 2a85998
commit b54dedd
Show file tree

Hide file tree

Showing 2 changed files with 51 additions and 28 deletions.
diff --git a/cmd/metal-api/internal/service/v1/switch.go b/cmd/metal-api/internal/service/v1/switch.go
@@ -72,16 +72,39 @@ type SwitchResponse struct {
 	Nics          SwitchNics         `json:"nics" description:"the list of network interfaces on the switch"`
 	Partition     PartitionResponse  `json:"partition" description:"the partition in which this switch is located"`
 	Connections   []SwitchConnection `json:"connections" description:"a connection between a switch port and a machine"`
-	LastSync      *metal.SwitchSync  `json:"last_sync" description:"last successful synchronization to the switch"`
-	LastSyncError *metal.SwitchSync  `json:"last_sync_error" description:"last synchronization to the switch that was erroneous"`
+	LastSync      *SwitchSync        `json:"last_sync" description:"last successful synchronization to the switch" optional:"true"`
+	LastSyncError *SwitchSync        `json:"last_sync_error" description:"last synchronization to the switch that was erroneous" optional:"true"`
 	Timestamps
 }
 
+type SwitchSync struct {
+	Time     time.Time     `json:"time" description:"point in time when the last switch sync happened"`
+	Duration time.Duration `json:"duration" description:"the duration that lat switch sync took"`
+	Error    *string       `json:"error" description:"shows the error occurred during the sync" optional:"true"`
+}
+
 func NewSwitchResponse(s *metal.Switch, p *metal.Partition, nics SwitchNics, cons []SwitchConnection) *SwitchResponse {
 	if s == nil {
 		return nil
 	}
 
+	var lastSync *SwitchSync
+	if s.LastSync != nil {
+		lastSync = &SwitchSync{
+			Time:     s.LastSync.Time,
+			Duration: s.LastSync.Duration,
+			Error:    s.LastSync.Error,
+		}
+	}
+	var lastSyncError *SwitchSync
+	if s.LastSyncError != nil {
+		lastSyncError = &SwitchSync{
+			Time:     s.LastSyncError.Time,
+			Duration: s.LastSyncError.Duration,
+			Error:    s.LastSyncError.Error,
+		}
+	}
+
 	return &SwitchResponse{
 		Common: Common{
 			Identifiable: Identifiable{
@@ -99,8 +122,8 @@ func NewSwitchResponse(s *metal.Switch, p *metal.Partition, nics SwitchNics, con
 		Nics:          nics,
 		Partition:     *NewPartitionResponse(p),
 		Connections:   cons,
-		LastSync:      s.LastSync,
-		LastSyncError: s.LastSyncError,
+		LastSync:      lastSync,
+		LastSyncError: lastSyncError,
 		Timestamps: Timestamps{
 			Created: s.Created,
 			Changed: s.Changed,

diff --git a/spec/metal-api.json b/spec/metal-api.json
@@ -18,26 +18,6 @@
         "statuscode"
       ]
     },
-    "metal.SwitchSync": {
-      "properties": {
-        "duration": {
-          "format": "integer",
-          "type": "integer"
-        },
-        "error": {
-          "type": "string"
-        },
-        "time": {
-          "format": "date-time",
-          "type": "string"
-        }
-      },
-      "required": [
-        "duration",
-        "error",
-        "time"
-      ]
-    },
     "rest.status": {
       "properties": {
         "message": {
@@ -2897,11 +2877,11 @@
           "uniqueItems": true
         },
         "last_sync": {
-          "$ref": "#/definitions/metal.SwitchSync",
+          "$ref": "#/definitions/v1.SwitchSync",
           "description": "last successful synchronization to the switch"
         },
         "last_sync_error": {
-          "$ref": "#/definitions/metal.SwitchSync",
+          "$ref": "#/definitions/v1.SwitchSync",
           "description": "last synchronization to the switch that was erroneous"
         },
         "mode": {
@@ -2931,13 +2911,33 @@
       "required": [
         "connections",
         "id",
-        "last_sync",
-        "last_sync_error",
         "nics",
         "partition",
         "rack_id"
       ]
     },
+    "v1.SwitchSync": {
+      "properties": {
+        "duration": {
+          "description": "the duration that lat switch sync took",
+          "format": "integer",
+          "type": "integer"
+        },
+        "error": {
+          "description": "shows the error occurred during the sync",
+          "type": "string"
+        },
+        "time": {
+          "description": "point in time when the last switch sync happened",
+          "format": "date-time",
+          "type": "string"
+        }
+      },
+      "required": [
+        "duration",
+        "time"
+      ]
+    },
     "v1.SwitchUpdateRequest": {
       "properties": {
         "description": {