Watchdog field documentation

Signed-off-by: David Vossel <[email protected]>
guangxuli · Nov 7, 2017 · 8d41e5b · 8d41e5b
1 parent 42e8d1e
commit 8d41e5b
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 2 deletions.
diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json
@@ -1617,6 +1617,9 @@
       "items": {
        "$ref": "#/definitions/v1.Video"
       }
+     },
+     "watchdog": {
+      "$ref": "#/definitions/v1.Watchdog"
      }
     }
    },
@@ -2864,6 +2867,23 @@
       "$ref": "#/definitions/v1.ListMeta"
      }
     }
+   },
+   "v1.Watchdog": {
+    "description": "Hardware watchdog device",
+    "required": [
+     "model",
+     "action"
+    ],
+    "properties": {
+     "action": {
+      "description": "The action to take. poweroff, reset, shutdown, pause, dump.",
+      "type": "string"
+     },
+     "model": {
+      "description": "Defines what watchdog model to use, typically 'i6300esb'",
+      "type": "string"
+     }
+    }
    }
   }
  }
diff --git a/pkg/api/v1/schema.go b/pkg/api/v1/schema.go
@@ -343,8 +343,11 @@ type Ballooning struct {
 type RandomGenerator struct {
 }
 
+// Hardware watchdog device
 type Watchdog struct {
-	Model  string `json:"model"`
+	// Defines what watchdog model to use, typically 'i6300esb'
+	Model string `json:"model"`
+	// The action to take. poweroff, reset, shutdown, pause, dump.
 	Action string `json:"action"`
 }
 

diff --git a/pkg/api/v1/schema_swagger_generated.go b/pkg/api/v1/schema_swagger_generated.go
@@ -203,5 +203,9 @@ func (RandomGenerator) SwaggerDoc() map[string]string {
 }
 
 func (Watchdog) SwaggerDoc() map[string]string {
-	return map[string]string{}
+	return map[string]string{
+		"":       "Hardware watchdog device",
+		"model":  "Defines what watchdog model to use, typically 'i6300esb'",
+		"action": "The action to take. poweroff, reset, shutdown, pause, dump.",
+	}
 }