summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJoffrey F <joffrey@docker.com>2016-08-19 16:46:21 -0700
committerJoffrey F <joffrey@docker.com>2016-08-19 16:51:13 -0700
commit97094e4ea303b59ce05869132cf639305a6d947a (patch)
tree2d07d95e8df436a6c642d0a195eafc16bd04bf6a /docs
parent02e99e4967bebb116a7d9d650647df912c608297 (diff)
downloaddocker-py-97094e4ea303b59ce05869132cf639305a6d947a.tar.gz
New docker.types subpackage containing advanced config dictionary types
Tests and docs updated to match docker.utils.types has been moved to docker.types Signed-off-by: Joffrey F <joffrey@docker.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/swarm.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/swarm.md b/docs/swarm.md
index 0cd015a..3cc44f8 100644
--- a/docs/swarm.md
+++ b/docs/swarm.md
@@ -95,7 +95,7 @@ Initialize a new Swarm using the current connected engine as the first node.
#### Client.create_swarm_spec
-Create a `docker.utils.SwarmSpec` instance that can be used as the `swarm_spec`
+Create a `docker.types.SwarmSpec` instance that can be used as the `swarm_spec`
argument in `Client.init_swarm`.
**Params:**
@@ -113,12 +113,12 @@ argument in `Client.init_swarm`.
heartbeat to the dispatcher.
* node_cert_expiry (int): Automatic expiry for nodes certificates.
* external_ca (dict): Configuration for forwarding signing requests to an
- external certificate authority. Use `docker.utils.SwarmExternalCA`.
+ external certificate authority. Use `docker.types.SwarmExternalCA`.
* name (string): Swarm's name
-**Returns:** `docker.utils.SwarmSpec` instance.
+**Returns:** `docker.types.SwarmSpec` instance.
-#### docker.utils.SwarmExternalCA
+#### docker.types.SwarmExternalCA
Create a configuration dictionary for the `external_ca` argument in a
`SwarmSpec`.