api/types: add GoDoc to Info.Warnings field

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-07-14 16:52:32 +02:00 · 2021-07-14 16:52:32 +02:00 · 7d63cbfd38
parent 4ace1998e5
commit 7d63cbfd38
1 changed files with 6 additions and 1 deletions
--- a/api/types/types.go
+++ b/api/types/types.go
@ -212,7 +212,12 @@ type Info struct {
 	SecurityOptions     []string
 	ProductLicense      string               `json:",omitempty"`
 	DefaultAddressPools []NetworkAddressPool `json:",omitempty"`
-	Warnings            []string
+
+	// Warnings contains a slice of warnings that occurred  while collecting
+	// system information. These warnings are intended to be informational
+	// messages for the user, and are not intended to be parsed / used for
+	// other purposes, as they do not have a fixed format.
+	Warnings []string
 }

 // KeyValue holds a key/value pair