Skip to content

Commit 89624e0

Browse files
thaJeztahthaJeztah
committed
api/types: migrate NetworkCreateResponse to network.CreateResponse
Migrate the type to the network package, and generate it from swagger. Signed-off-by: Sebastiaan van Stijn <[email protected]>
1 parent 2ebf191 commit 89624e0

12 files changed

Lines changed: 61 additions & 30 deletions

File tree

‎api/server/router/network/backend.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import (
1313
// to provide network specific functionality.
1414
type Backend interface {
1515
GetNetworks(filters.Args, backend.NetworkListConfig) ([]types.NetworkResource, error)
16-
CreateNetwork(nc types.NetworkCreateRequest) (*types.NetworkCreateResponse, error)
16+
CreateNetwork(nc types.NetworkCreateRequest) (*network.CreateResponse, error)
1717
ConnectContainerToNetwork(containerName, networkName string, endpointConfig *network.EndpointSettings) error
1818
DisconnectContainerFromNetwork(containerName string, networkName string, force bool) error
1919
DeleteNetwork(networkID string) error

‎api/server/router/network/network_routes.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ func (n *networkRouter) postNetworkCreate(ctx context.Context, w http.ResponseWr
226226
if err != nil {
227227
return err
228228
}
229-
nw = &types.NetworkCreateResponse{
229+
nw = &network.CreateResponse{
230230
ID: id,
231231
}
232232
}

‎api/swagger.yaml‎

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2380,6 +2380,24 @@ definitions:
23802380
type: "string"
23812381
example: "10.133.77.91"
23822382

2383+
NetworkCreateResponse:
2384+
description: "OK response to NetworkCreate operation"
2385+
type: "object"
2386+
title: "NetworkCreateResponse"
2387+
x-go-name: "CreateResponse"
2388+
required: [Id, Warning]
2389+
properties:
2390+
Id:
2391+
description: "The ID of the created network."
2392+
type: "string"
2393+
x-nullable: false
2394+
example: "b5c4fc71e8022147cd25de22b22173de4e3b170134117172eb595cb91b4e7e5d"
2395+
Warning:
2396+
description: "Warnings encountered when creating the container"
2397+
type: "string"
2398+
x-nullable: false
2399+
example: ""
2400+
23832401
BuildInfo:
23842402
type: "object"
23852403
properties:
@@ -10144,19 +10162,9 @@ paths:
1014410162
- "application/json"
1014510163
responses:
1014610164
201:
10147-
description: "No error"
10165+
description: "Network created successfully"
1014810166
schema:
10149-
type: "object"
10150-
title: "NetworkCreateResponse"
10151-
properties:
10152-
Id:
10153-
description: "The ID of the created network."
10154-
type: "string"
10155-
Warning:
10156-
type: "string"
10157-
example:
10158-
Id: "22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30"
10159-
Warning: ""
10167+
$ref: "#/definitions/NetworkCreateResponse"
1016010168
400:
1016110169
description: "bad parameter"
1016210170
schema:

‎api/types/network/create_response.go‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
package network
2+
3+
// This file was generated by the swagger tool.
4+
// Editing this file might prove futile when you re-run the swagger generate command
5+
6+
// CreateResponse NetworkCreateResponse
7+
//
8+
// OK response to NetworkCreate operation
9+
// swagger:model CreateResponse
10+
type CreateResponse struct {
11+
12+
// The ID of the created network.
13+
// Required: true
14+
ID string `json:"Id"`
15+
16+
// Warnings encountered when creating the container
17+
// Required: true
18+
Warning string `json:"Warning"`
19+
}

‎api/types/types.go‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -477,12 +477,6 @@ type NetworkCreateRequest struct {
477477
Name string // Name is the requested name of the network.
478478
}
479479

480-
// NetworkCreateResponse is the response message sent by the server for network create call
481-
type NetworkCreateResponse struct {
482-
ID string `json:"Id"`
483-
Warning string
484-
}
485-
486480
// NetworkConnect represents the data to be used to connect a container to the network
487481
type NetworkConnect struct {
488482
Container string

‎api/types/types_deprecated.go‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ package types
22

33
import (
44
"github.com/docker/docker/api/types/image"
5+
"github.com/docker/docker/api/types/network"
56
)
67

78
// ImageImportOptions holds information to import images from the client host.
@@ -33,3 +34,8 @@ type ImageListOptions = image.ListOptions
3334
//
3435
// Deprecated: use [image.RemoveOptions].
3536
type ImageRemoveOptions = image.RemoveOptions
37+
38+
// NetworkCreateResponse is the response message sent by the server for network create call.
39+
//
40+
// Deprecated: use [network.CreateResponse].
41+
type NetworkCreateResponse = network.CreateResponse

‎client/interface.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ type ImageAPIClient interface {
108108
// NetworkAPIClient defines API client methods for the networks
109109
type NetworkAPIClient interface {
110110
NetworkConnect(ctx context.Context, network, container string, config *network.EndpointSettings) error
111-
NetworkCreate(ctx context.Context, name string, options types.NetworkCreate) (types.NetworkCreateResponse, error)
111+
NetworkCreate(ctx context.Context, name string, options types.NetworkCreate) (network.CreateResponse, error)
112112
NetworkDisconnect(ctx context.Context, network, container string, force bool) error
113113
NetworkInspect(ctx context.Context, network string, options types.NetworkInspectOptions) (types.NetworkResource, error)
114114
NetworkInspectWithRaw(ctx context.Context, network string, options types.NetworkInspectOptions) (types.NetworkResource, []byte, error)

‎client/network_create.go‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,13 @@ import (
55
"encoding/json"
66

77
"github.com/docker/docker/api/types"
8+
"github.com/docker/docker/api/types/network"
89
"github.com/docker/docker/api/types/versions"
910
)
1011

1112
// NetworkCreate creates a new network in the docker host.
12-
func (cli *Client) NetworkCreate(ctx context.Context, name string, options types.NetworkCreate) (types.NetworkCreateResponse, error) {
13-
var response types.NetworkCreateResponse
13+
func (cli *Client) NetworkCreate(ctx context.Context, name string, options types.NetworkCreate) (network.CreateResponse, error) {
14+
var response network.CreateResponse
1415

1516
// Make sure we negotiated (if the client is configured to do so),
1617
// as code below contains API-version specific handling of options.

‎client/network_create_test.go‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import (
1111
"testing"
1212

1313
"github.com/docker/docker/api/types"
14+
"github.com/docker/docker/api/types/network"
1415
"github.com/docker/docker/errdefs"
1516
"gotest.tools/v3/assert"
1617
is "gotest.tools/v3/assert/cmp"
@@ -50,7 +51,7 @@ func TestNetworkCreate(t *testing.T) {
5051
return nil, fmt.Errorf("expected POST method, got %s", req.Method)
5152
}
5253

53-
content, err := json.Marshal(types.NetworkCreateResponse{
54+
content, err := json.Marshal(network.CreateResponse{
5455
ID: "network_id",
5556
Warning: "warning",
5657
})

‎daemon/network.go‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -286,11 +286,11 @@ func (daemon *Daemon) CreateManagedNetwork(create clustertypes.NetworkCreateRequ
286286
}
287287

288288
// CreateNetwork creates a network with the given name, driver and other optional parameters
289-
func (daemon *Daemon) CreateNetwork(create types.NetworkCreateRequest) (*types.NetworkCreateResponse, error) {
289+
func (daemon *Daemon) CreateNetwork(create types.NetworkCreateRequest) (*network.CreateResponse, error) {
290290
return daemon.createNetwork(&daemon.config().Config, create, "", false)
291291
}
292292

293-
func (daemon *Daemon) createNetwork(cfg *config.Config, create types.NetworkCreateRequest, id string, agent bool) (*types.NetworkCreateResponse, error) {
293+
func (daemon *Daemon) createNetwork(cfg *config.Config, create types.NetworkCreateRequest, id string, agent bool) (*network.CreateResponse, error) {
294294
if runconfig.IsPreDefinedNetwork(create.Name) {
295295
return nil, PredefinedNetworkError(create.Name)
296296
}
@@ -396,9 +396,7 @@ func (daemon *Daemon) createNetwork(cfg *config.Config, create types.NetworkCrea
396396
}
397397
daemon.LogNetworkEvent(n, events.ActionCreate)
398398

399-
return &types.NetworkCreateResponse{
400-
ID: n.ID(),
401-
}, nil
399+
return &network.CreateResponse{ID: n.ID()}, nil
402400
}
403401

404402
func (daemon *Daemon) pluginRefCount(driver, capability string, mode int) {

0 commit comments

Comments
 (0)