1. docker
  2. Commit bfe711bed342202ed0918a309b2000bb158c4eb7
Browse code

Add API change to docs

Add API change description to docs due to `docker network inspect`
returns different data structure.

Signed-off-by: Zhang Wei <zhangwei555@huawei.com>

Zhang Wei authored on 2015/11/20 20:41:25
Showing 4 changed files
docs/reference/api/docker_remote_api.md
History View file @ bfe711b
... ... 
@@ -95,6 +95,7 @@ This section lists each version from latest to oldest.  Each listing includes a
95 95 
 [Docker Remote API v1.22](docker_remote_api_v1.22.md) documentation
96 96
97 97 
 * `GET /containers/json` supports filter `isolation` on Windows.
98 
+* `GET /networks/(name)` now returns a `Name` field for each container attached to the network.
98 99
99 100 
 ### v1.21 API changes
100 101
docs/reference/api/docker_remote_api_v1.22.md
History View file @ bfe711b
... ... 
@@ -2692,6 +2692,7 @@ Content-Type: application/json
2692 2692 
   },
2693 2693 
   "Containers": {
2694 2694 
     "39b69226f9d79f5634485fb236a23b2fe4e96a0a94128390a7fbbcc167065867": {
2695 
+      "Name": "mad_mclean",
2695 2696 
       "EndpointID": "ed2419a97c1d9954d05b46e462e7002ea552f216e9b136b80a7db8d98b442eda",
2696 2697 
       "MacAddress": "02:42:ac:11:00:02",
2697 2698 
       "IPv4Address": "172.17.0.2/16",
docs/reference/commandline/network_inspect.md
History View file @ bfe711b
... ... 
@@ -31,25 +31,45 @@ The `network inspect` command shows the containers, by id, in its results.
31 31 
 ```bash
32 32 
 $ sudo docker network inspect bridge
33 33 
 [
34 
-  {
35 
-      "name": "bridge",
36 
-      "id": "7fca4eb8c647e57e9d46c32714271e0c3f8bf8d17d346629e2820547b2d90039",
37 
-      "driver": "bridge",
38 
-      "containers": {
39 
-          "bda12f8922785d1f160be70736f26c1e331ab8aaf8ed8d56728508f2e2fd4727": {
40 
-              "endpoint": "e0ac95934f803d7e36384a2029b8d1eeb56cb88727aa2e8b7edfeebaa6dfd758",
41 
-              "mac_address": "02:42:ac:11:00:03",
42 
-              "ipv4_address": "172.17.0.3/16",
43 
-              "ipv6_address": ""
44 
-          },
45 
-          "f2870c98fd504370fb86e59f32cd0753b1ac9b69b7d80566ffc7192a82b3ed27": {
46 
-              "endpoint": "31de280881d2a774345bbfb1594159ade4ae4024ebfb1320cb74a30225f6a8ae",
47 
-              "mac_address": "02:42:ac:11:00:02",
48 
-              "ipv4_address": "172.17.0.2/16",
49 
-              "ipv6_address": ""
50 
-          }
51 
-      }
52 
-  }
34 
+    {
35 
+        "Name": "bridge",
36 
+        "Id": "b2b1a2cba717161d984383fd68218cf70bbbd17d328496885f7c921333228b0f",
37 
+        "Scope": "local",
38 
+        "Driver": "bridge",
39 
+        "IPAM": {
40 
+            "Driver": "default",
41 
+            "Config": [
42 
+                {
43 
+                    "Subnet": "172.17.42.1/16",
44 
+                    "Gateway": "172.17.42.1"
45 
+                }
46 
+            ]
47 
+        },
48 
+        "Containers": {
49 
+            "bda12f8922785d1f160be70736f26c1e331ab8aaf8ed8d56728508f2e2fd4727": {
50 
+                "Name": "container2",
51 
+                "EndpointID": "0aebb8fcd2b282abe1365979536f21ee4ceaf3ed56177c628eae9f706e00e019",
52 
+                "MacAddress": "02:42:ac:11:00:02",
53 
+                "IPv4Address": "172.17.0.2/16",
54 
+                "IPv6Address": ""
55 
+            },
56 
+            "f2870c98fd504370fb86e59f32cd0753b1ac9b69b7d80566ffc7192a82b3ed27": {
57 
+                "Name": "container1",
58 
+                "EndpointID": "a00676d9c91a96bbe5bcfb34f705387a33d7cc365bac1a29e4e9728df92d10ad",
59 
+                "MacAddress": "02:42:ac:11:00:01",
60 
+                "IPv4Address": "172.17.0.1/16",
61 
+                "IPv6Address": ""
62 
+            }
63 
+        },
64 
+        "Options": {
65 
+            "com.docker.network.bridge.default_bridge": "true",
66 
+            "com.docker.network.bridge.enable_icc": "true",
67 
+            "com.docker.network.bridge.enable_ip_masquerade": "true",
68 
+            "com.docker.network.bridge.host_binding_ipv4": "0.0.0.0",
69 
+            "com.docker.network.bridge.name": "docker0",
70 
+            "com.docker.network.driver.mtu": "1500"
71 
+        }
72 
+    }
53 73 
 ]
54 74 
 ```
55 75
man/docker-network-inspect.1.md
History View file @ bfe711b
... ... 
@@ -26,29 +26,48 @@ The `network inspect` command shows the containers, by id, in its results.
26 26 
 ```bash
27 27 
 $ sudo docker network inspect bridge
28 28 
 [
29 
-  {
30 
-      "name": "bridge",
31 
-      "id": "7fca4eb8c647e57e9d46c32714271e0c3f8bf8d17d346629e2820547b2d90039",
32 
-      "driver": "bridge",
33 
-      "containers": {
34 
-          "bda12f8922785d1f160be70736f26c1e331ab8aaf8ed8d56728508f2e2fd4727": {
35 
-              "endpoint": "e0ac95934f803d7e36384a2029b8d1eeb56cb88727aa2e8b7edfeebaa6dfd758",
36 
-              "mac_address": "02:42:ac:11:00:03",
37 
-              "ipv4_address": "172.17.0.3/16",
38 
-              "ipv6_address": ""
39 
-          },
40 
-          "f2870c98fd504370fb86e59f32cd0753b1ac9b69b7d80566ffc7192a82b3ed27": {
41 
-              "endpoint": "31de280881d2a774345bbfb1594159ade4ae4024ebfb1320cb74a30225f6a8ae",
42 
-              "mac_address": "02:42:ac:11:00:02",
43 
-              "ipv4_address": "172.17.0.2/16",
44 
-              "ipv6_address": ""
45 
-          }
46 
-      }
47 
-  }
29 
+    {
30 
+        "Name": "bridge",
31 
+        "Id": "b2b1a2cba717161d984383fd68218cf70bbbd17d328496885f7c921333228b0f",
32 
+        "Scope": "local",
33 
+        "Driver": "bridge",
34 
+        "IPAM": {
35 
+            "Driver": "default",
36 
+            "Config": [
37 
+                {
38 
+                    "Subnet": "172.17.42.1/16",
39 
+                    "Gateway": "172.17.42.1"
40 
+                }
41 
+            ]
42 
+        },
43 
+        "Containers": {
44 
+            "bda12f8922785d1f160be70736f26c1e331ab8aaf8ed8d56728508f2e2fd4727": {
45 
+                "Name": "container2",
46 
+                "EndpointID": "0aebb8fcd2b282abe1365979536f21ee4ceaf3ed56177c628eae9f706e00e019",
47 
+                "MacAddress": "02:42:ac:11:00:02",
48 
+                "IPv4Address": "172.17.0.2/16",
49 
+                "IPv6Address": ""
50 
+            },
51 
+            "f2870c98fd504370fb86e59f32cd0753b1ac9b69b7d80566ffc7192a82b3ed27": {
52 
+                "Name": "container1",
53 
+                "EndpointID": "a00676d9c91a96bbe5bcfb34f705387a33d7cc365bac1a29e4e9728df92d10ad",
54 
+                "MacAddress": "02:42:ac:11:00:01",
55 
+                "IPv4Address": "172.17.0.1/16",
56 
+                "IPv6Address": ""
57 
+            }
58 
+        },
59 
+        "Options": {
60 
+            "com.docker.network.bridge.default_bridge": "true",
61 
+            "com.docker.network.bridge.enable_icc": "true",
62 
+            "com.docker.network.bridge.enable_ip_masquerade": "true",
63 
+            "com.docker.network.bridge.host_binding_ipv4": "0.0.0.0",
64 
+            "com.docker.network.bridge.name": "docker0",
65 
+            "com.docker.network.driver.mtu": "1500"
66 
+        }
67 
+    }
48 68 
 ]
49 69 
 ```
50 70
51 
-
52 71 
 # OPTIONS
53 72
54 73 
 **--help**