object-mapper: Clarify GetSubTree interfaces param
The existing documentation on the optional <interfaces> parameter to the
GetSubTree handler and other related handlers is not clear. The wording
implies that the only interfaces returned in the dictionary will be the
ones specified by the <interfaces> parameter.
The examples show that is not the behavior.
The implementation of getSubTree() confirms this behavior. [1]
I've reworded like GetObject handler to clarify.
[1] https://github.com/openbmc/phosphor-objmgr/blob/d01fca35bf709c179ba5ade01b127b2a31ebfbce/src/handler.cpp#L139
Change-Id: Icdf407d677e8ba4c235bb10aad67d90e096ac88e
Signed-off-by: Janet Adkins <janeta@us.ibm.com>
diff --git a/architecture/object-mapper.md b/architecture/object-mapper.md
index a0c7273..59ca584 100644
--- a/architecture/object-mapper.md
+++ b/architecture/object-mapper.md
@@ -57,9 +57,10 @@
### GetSubTree
Use this method to find the objects, services, and interfaces in the specified
-subtree that implement a certain interface. If no interfaces are passed in, then
-all objects/services/interfaces in the subtree are returned. If interfaces are
-passed in, then only those interfaces are returned in the output.
+subtree that implement a certain interface. An optional list of interfaces may
+also be passed in to constrain the output to services that implement those
+specific interfaces. If no interfaces are passed in, then all
+objects/services/interfaces in the subtree are returned.
Inputs:
@@ -118,10 +119,10 @@
Use this method to find the objects, services, and interfaces in the specified
subtree that implement a certain interface and an endpoint of the input
-associationPath. If no interfaces are passed in, then all
-objects/services/interfaces in the subtree and associated endpoint are returned.
-If interfaces are passed in, then only those interfaces are returned in the
-output.
+associationPath. An optional list of interfaces may also be passed in to
+constrain the output to services that implement those specific interfaces. If no
+interfaces are passed in, then all objects/services/interfaces in the subtree
+and associated endpoint are returned.
Inputs:
@@ -192,9 +193,10 @@
Use this method to find the objects, services, and interfaces in the specified
subtree that implement certain interfaces and endpoints that end by input `id`.
-If no interfaces are passed in, then all objects/services/interfaces in the
-subtree and associated endpoint are returned. If interfaces are passed in, then
-only those interfaces are returned in the output.
+An optional list of interfaces may also be passed in to constrain the output to
+services that implement those specific interfaces. If no interfaces are passed
+in, then all objects/services/interfaces in the subtree and associated endpoint
+are returned.
Inputs: