Browse code

api/types: document classic swarm "Node" field

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

Sebastiaan van Stijn authored on 2020/01/03 19:49:12
Showing 1 changed files
... ...
@@ -154,7 +154,7 @@ type Info struct {
154 154
 	Images             int
155 155
 	Driver             string
156 156
 	DriverStatus       [][2]string
157
-	SystemStatus       [][2]string
157
+	SystemStatus       [][2]string // SystemStatus is only propagated by the Swarm standalone API
158 158
 	Plugins            PluginsInfo
159 159
 	MemoryLimit        bool
160 160
 	SwapLimit          bool
... ...
@@ -318,7 +318,7 @@ type ContainerState struct {
318 318
 }
319 319
 
320 320
 // ContainerNode stores information about the node that a container
321
-// is running on.  It's only available in Docker Swarm
321
+// is running on.  It's only used by the Docker Swarm standalone API
322 322
 type ContainerNode struct {
323 323
 	ID        string
324 324
 	IPAddress string `json:"IP"`
... ...
@@ -342,7 +342,7 @@ type ContainerJSONBase struct {
342 342
 	HostnamePath    string
343 343
 	HostsPath       string
344 344
 	LogPath         string
345
-	Node            *ContainerNode `json:",omitempty"`
345
+	Node            *ContainerNode `json:",omitempty"` // Node is only propagated by Docker Swarm standalone API
346 346
 	Name            string
347 347
 	RestartCount    int
348 348
 	Driver          string