Browse Source

api/types: document classic swarm "Node" field

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Sebastiaan van Stijn 5 years ago
parent
commit
78c86927ab
1 changed files with 3 additions and 3 deletions
  1. 3 3
      api/types/types.go

+ 3 - 3
api/types/types.go

@@ -154,7 +154,7 @@ type Info struct {
 	Images             int
 	Images             int
 	Driver             string
 	Driver             string
 	DriverStatus       [][2]string
 	DriverStatus       [][2]string
-	SystemStatus       [][2]string
+	SystemStatus       [][2]string // SystemStatus is only propagated by the Swarm standalone API
 	Plugins            PluginsInfo
 	Plugins            PluginsInfo
 	MemoryLimit        bool
 	MemoryLimit        bool
 	SwapLimit          bool
 	SwapLimit          bool
@@ -318,7 +318,7 @@ type ContainerState struct {
 }
 }
 
 
 // ContainerNode stores information about the node that a container
 // ContainerNode stores information about the node that a container
-// is running on.  It's only available in Docker Swarm
+// is running on.  It's only used by the Docker Swarm standalone API
 type ContainerNode struct {
 type ContainerNode struct {
 	ID        string
 	ID        string
 	IPAddress string `json:"IP"`
 	IPAddress string `json:"IP"`
@@ -342,7 +342,7 @@ type ContainerJSONBase struct {
 	HostnamePath    string
 	HostnamePath    string
 	HostsPath       string
 	HostsPath       string
 	LogPath         string
 	LogPath         string
-	Node            *ContainerNode `json:",omitempty"`
+	Node            *ContainerNode `json:",omitempty"` // Node is only propagated by Docker Swarm standalone API
 	Name            string
 	Name            string
 	RestartCount    int
 	RestartCount    int
 	Driver          string
 	Driver          string