From 7d63cbfd38d6059bfd56e89820948561fcead628 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Wed, 14 Jul 2021 16:52:32 +0200 Subject: [PATCH] api/types: add GoDoc to Info.Warnings field Signed-off-by: Sebastiaan van Stijn --- api/types/types.go | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/api/types/types.go b/api/types/types.go index 9d31f70d64..d6017898d0 100644 --- 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