Skip to content

Commit 1e26019

Browse files
committed
DOC: add all API functions to the API reference
1 parent bf6a892 commit 1e26019

File tree

1 file changed

+139
-0
lines changed

1 file changed

+139
-0
lines changed

docs/source/api-reference.rst

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,36 @@ Authentication
2323
SaveRestoreAPI.auth_gen
2424
SaveRestoreAPI.auth_set
2525
SaveRestoreAPI.auth_clear
26+
SaveRestoreAPI.login
27+
28+
Info Controller API
29+
*******************
30+
31+
.. autosummary::
32+
:nosignatures:
33+
:toctree: generated
34+
35+
SaveRestoreAPI.info_get
36+
SaveRestoreAPI.version_get
37+
38+
Search Controller API
39+
*********************
40+
41+
.. autosummary::
42+
:nosignatures:
43+
:toctree: generated
44+
45+
SaveRestoreAPI.search
46+
47+
Help Controller API
48+
*******************
49+
50+
.. autosummary::
51+
:nosignatures:
52+
:toctree: generated
53+
54+
SaveRestoreAPI.help
55+
2656

2757
Node Controller API
2858
*******************
@@ -40,6 +70,115 @@ Node Controller API
4070
SaveRestoreAPI.node_get_parent
4171

4272

73+
Configuration Controller API
74+
****************************
75+
76+
.. autosummary::
77+
:nosignatures:
78+
:toctree: generated
79+
80+
SaveRestoreAPI.config_get
81+
SaveRestoreAPI.config_add
82+
SaveRestoreAPI.config_update
83+
84+
85+
Tag Controller API
86+
******************
87+
88+
.. autosummary::
89+
:nosignatures:
90+
:toctree: generated
91+
92+
SaveRestoreAPI.tags_get
93+
SaveRestoreAPI.tags_add
94+
SaveRestoreAPI.tags_delete
95+
96+
97+
Take Snapshot Controller API
98+
****************************
99+
100+
.. autosummary::
101+
:nosignatures:
102+
:toctree: generated
103+
104+
SaveRestoreAPI.take_snapshot_get
105+
SaveRestoreAPI.take_snapshot_save
106+
107+
108+
Snapshot Controller API
109+
***********************
110+
111+
.. autosummary::
112+
:nosignatures:
113+
:toctree: generated
114+
115+
SaveRestoreAPI.snapshot_get
116+
SaveRestoreAPI.snapshot_add
117+
SaveRestoreAPI.snapshot_update
118+
SaveRestoreAPI.snapshots_get
119+
120+
121+
Composite Snapshot Controller API
122+
*********************************
123+
124+
.. autosummary::
125+
:nosignatures:
126+
:toctree: generated
127+
128+
SaveRestoreAPI.composite_snapshot_get
129+
SaveRestoreAPI.composite_snapshot_get_nodes
130+
SaveRestoreAPI.composite_snapshot_get_items
131+
SaveRestoreAPI.composite_snapshot_add
132+
SaveRestoreAPI.composite_snapshot_update
133+
SaveRestoreAPI.composite_snapshot_consistency_check
134+
135+
136+
Snapshot Restore Controller API
137+
*******************************
138+
139+
.. autosummary::
140+
:nosignatures:
141+
:toctree: generated
142+
143+
SaveRestoreAPI.restore_node
144+
SaveRestoreAPI.restore_items
145+
146+
147+
Comparison Controller API
148+
*************************
149+
150+
.. autosummary::
151+
:nosignatures:
152+
:toctree: generated
153+
154+
SaveRestoreAPI.compare
155+
156+
157+
Filter Controller API
158+
*********************
159+
160+
.. autosummary::
161+
:nosignatures:
162+
:toctree: generated
163+
164+
SaveRestoreAPI.filter_add
165+
SaveRestoreAPI.filters_get
166+
SaveRestoreAPI.filter_delete
167+
168+
169+
Structure Controller API
170+
************************
171+
172+
.. autosummary::
173+
:nosignatures:
174+
:toctree: generated
175+
176+
SaveRestoreAPI.structure_move
177+
SaveRestoreAPI.structure_copy
178+
SaveRestoreAPI.structure_path_get
179+
SaveRestoreAPI.structure_path_nodes
180+
181+
43182
Asynchronous Communication with 0MQ Server
44183
------------------------------------------
45184

0 commit comments

Comments
 (0)