Skip to content

Commit 784172b

Browse files
committed
Add missing secrets doc
Signed-off-by: Joffrey F <[email protected]>
1 parent b1d6e01 commit 784172b

File tree

5 files changed

+42
-1
lines changed

5 files changed

+42
-1
lines changed

docs/api.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,15 @@ Plugins
9797
:members:
9898
:undoc-members:
9999

100+
Secrets
101+
-------
102+
103+
.. py:module:: docker.api.secret
104+
105+
.. rst-class:: hide-signature
106+
.. autoclass:: SecretApiMixin
107+
:members:
108+
:undoc-members:
100109

101110
The Docker daemon
102111
-----------------
@@ -121,6 +130,7 @@ Configuration types
121130
.. autoclass:: Mount
122131
.. autoclass:: Resources
123132
.. autoclass:: RestartPolicy
133+
.. autoclass:: SecretReference
124134
.. autoclass:: ServiceMode
125135
.. autoclass:: TaskTemplate
126136
.. autoclass:: UpdateConfig

docs/client.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Client reference
2020
.. autoattribute:: networks
2121
.. autoattribute:: nodes
2222
.. autoattribute:: plugins
23+
.. autoattribute:: secrets
2324
.. autoattribute:: services
2425
.. autoattribute:: swarm
2526
.. autoattribute:: volumes

docs/images.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ Methods available on ``client.images``:
1414
.. automethod:: get
1515
.. automethod:: list(**kwargs)
1616
.. automethod:: load
17+
.. automethod:: prune
1718
.. automethod:: pull
1819
.. automethod:: push
1920
.. automethod:: remove
2021
.. automethod:: search
21-
.. automethod:: prune
2222

2323

2424
Image objects

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@ That's just a taste of what you can do with the Docker SDK for Python. For more,
8585
networks
8686
nodes
8787
plugins
88+
secrets
8889
services
8990
swarm
9091
volumes

docs/secrets.rst

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
Secrets
2+
=======
3+
4+
.. py:module:: docker.models.secrets
5+
6+
Manage secrets on the server.
7+
8+
Methods available on ``client.secrets``:
9+
10+
.. rst-class:: hide-signature
11+
.. py:class:: SecretCollection
12+
13+
.. automethod:: create
14+
.. automethod:: get
15+
.. automethod:: list
16+
17+
18+
Secret objects
19+
--------------
20+
21+
.. autoclass:: Secret()
22+
23+
.. autoattribute:: id
24+
.. autoattribute:: name
25+
.. py:attribute:: attrs
26+
27+
The raw representation of this object from the server.
28+
29+
.. automethod:: remove

0 commit comments

Comments
 (0)