Updated API description and spec

Relates to: eclipse-bluechi#889 Added ListUnitFiles to the API description for the readthedocs and in the API specification for the internal Agent interface. Signed-off-by: Michael Engel <[email protected]>
engelmi · Sep 11, 2024 · 5616df1 · 5616df1
1 parent 0dba297
commit 5616df1
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/data/org.eclipse.bluechi.internal.Agent.xml b/data/org.eclipse.bluechi.internal.Agent.xml
@@ -63,6 +63,9 @@
     <method name="ListUnits">
       <arg name="units" type="a(ssssssouso)" direction="out" />
     </method>
+    <method name="ListUnitFiles">
+      <arg name="units" type="a(ss)" direction="out" />
+    </method>
     <method name="Subscribe">
       <arg name="unit" type="s" direction="in" />
     </method>

diff --git a/doc/docs/api/description.md b/doc/docs/api/description.md
@@ -21,6 +21,12 @@ Note that some properties also come with change events, so you can easily track
     Returns an array with all currently loaded systemd units on all online nodes. This is equivalent to calling
     `Node.ListUnits()` on all the online nodes and adding the name of the node as the first element of each returned
     element struct.
+
+  * `ListUnitFiles(out a(sss) unit_files)`
+
+    Returns an array with all systemd unit files on all online nodes. This is equivalent to calling
+    `Node.ListUnitFiles()` on all the online nodes and adding the name of the node as the first element of each returned
+    element struct.
 
   * `CreateMonitor(out o monitor)`
 
@@ -200,6 +206,11 @@ Object path: `/org/eclipse/bluechi/node/$name`
     Returns all the currently loaded systemd units on this node. The returned structure is the same as the one returned
     by the systemd `ListUnits()` call.
 
+  * `ListUnitFiles(out a(ss) unit_files)`
+
+    Returns all the systemd unit files on this node. The returned structure is the same as the one returned
+    by the systemd `ListUnitFiles()` call.
+
   * `Reload()`
 
     `Reload()` may be invoked to reload all unit files.
@@ -344,7 +355,9 @@ This is the main interface that the node implements and that is used by the cont
 
   * `GetUnitProperties(in name, out a{sv} props)`
 
-  * `ListUnits(out a(ssssssouso) units);`
+  * `ListUnits(out a(ssssssouso) units)`
+
+  * `ListUnitFiles(out a(ss) units)`
 
     These are all API mirrors of the respective method in `org.eclipse.bluechi.Node`, and all they do is forward the
     same operation to the local systemd instance. Similarly, any changes in the systemd job will be forwarded to signals