Browse code

swagger: move NetworkingConfig to definitions

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 89876e816585d814b31a2c5c9814eeda92b081bc)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

Sebastiaan van Stijn authored on 2020/07/03 22:11:54
Showing 1 changed files
... ...
@@ -1202,6 +1202,42 @@ definitions:
1202 1202
         items:
1203 1203
           type: "string"
1204 1204
 
1205
+  NetworkingConfig:
1206
+    description: |
1207
+      NetworkingConfig represents the container's networking configuration for
1208
+      each of its interfaces.
1209
+      It is used for the networking configs specified in the `docker create`
1210
+      and `docker network connect` commands.
1211
+    type: "object"
1212
+    properties:
1213
+      EndpointsConfig:
1214
+        description: |
1215
+          A mapping of network name to endpoint configuration for that network.
1216
+        type: "object"
1217
+        additionalProperties:
1218
+          $ref: "#/definitions/EndpointSettings"
1219
+    example:
1220
+      # putting an example here, instead of using the example values from
1221
+      # /definitions/EndpointSettings, because containers/create currently
1222
+      # does not support attaching to multiple networks, so the example request
1223
+      # would be confusing if it showed that multiple networks can be contained
1224
+      # in the EndpointsConfig.
1225
+      # TODO remove once we support multiple networks on container create (see https://github.com/moby/moby/blob/07e6b843594e061f82baa5fa23c2ff7d536c2a05/daemon/create.go#L323)
1226
+      EndpointsConfig:
1227
+        isolated_nw:
1228
+          IPAMConfig:
1229
+            IPv4Address: "172.20.30.33"
1230
+            IPv6Address: "2001:db8:abcd::3033"
1231
+            LinkLocalIPs:
1232
+              - "169.254.34.68"
1233
+              - "fe80::3468"
1234
+          Links:
1235
+            - "container_1"
1236
+            - "container_2"
1237
+          Aliases:
1238
+            - "server_x"
1239
+            - "server_y"
1240
+
1205 1241
   NetworkSettings:
1206 1242
     description: "NetworkSettings exposes the network settings in the API"
1207 1243
     type: "object"
... ...
@@ -5123,16 +5159,7 @@ paths:
5123 5123
                   HostConfig:
5124 5124
                     $ref: "#/definitions/HostConfig"
5125 5125
                   NetworkingConfig:
5126
-                    description: "This container's networking configuration."
5127
-                    type: "object"
5128
-                    properties:
5129
-                      EndpointsConfig:
5130
-                        description: |
5131
-                          A mapping of network name to endpoint configuration
5132
-                          for that network.
5133
-                        type: "object"
5134
-                        additionalProperties:
5135
-                          $ref: "#/definitions/EndpointSettings"
5126
+                    $ref: "#/definitions/NetworkingConfig"
5136 5127
             example:
5137 5128
               Hostname: ""
5138 5129
               Domainname: ""