Skip to content
This repository has been archived by the owner on Oct 13, 2023. It is now read-only.

Commit

Permalink
Update service networks documentation
Browse files Browse the repository at this point in the history
The previous description stated that an array of names / ids could be passed when the API in reality expects objects in the form of NetworkAttachmentConfig. This is fixed by updating the description and adding a definition for NetworkAttachmentConfig.

Signed-off-by: Hannes Ljungberg <hannes@5monkeys.se>
(cherry picked from commit 4d09fab)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
  • Loading branch information
hannseman authored and thaJeztah committed Jan 17, 2020
1 parent e4e71dc commit 37851d8
Showing 1 changed file with 23 additions and 17 deletions.
40 changes: 23 additions & 17 deletions api/swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3002,16 +3002,10 @@ definitions:
description: "Runtime is the type of runtime specified for the task executor."
type: "string"
Networks:
description: "Specifies which networks the service should attach to."
type: "array"
items:
type: "object"
properties:
Target:
type: "string"
Aliases:
type: "array"
items:
type: "string"
$ref: "#/definitions/NetworkAttachmentConfig"
LogDriver:
description: "Specifies the log driver to use for tasks created from this spec. If not present, the default one for the swarm will be used, finally falling back to the engine default if not specified."
type: "object"
Expand Down Expand Up @@ -3257,17 +3251,11 @@ definitions:
- "stop-first"
- "start-first"
Networks:
description: "Array of network names or IDs to attach the service to."
description: "Specifies which networks the service should attach to."
type: "array"
items:
type: "object"
properties:
Target:
type: "string"
Aliases:
type: "array"
items:
type: "string"
$ref: "#/definitions/NetworkAttachmentConfig"

EndpointSpec:
$ref: "#/definitions/EndpointSpec"

Expand Down Expand Up @@ -4439,6 +4427,24 @@ definitions:
IP address and ports at which this node can be reached.
type: "string"

NetworkAttachmentConfig:
description: "Specifies how a service should be attached to a particular network."
type: "object"
properties:
Target:
description: "The target network for attachment. Must be a network name or ID."
type: "string"
Aliases:
description: "Discoverable alternate names for the service on this network."
type: "array"
items:
type: "string"
DriverOpts:
description: "Driver attachment options for the network target"
type: "object"
additionalProperties:
type: "string"

paths:
/containers/json:
get:
Expand Down

0 comments on commit 37851d8

Please sign in to comment.