object-mapper: document error returns on methods
The ObjectMapper can return errors in cases where a query results
in no services and/or object paths: Common.ResourceNotFound. Add
this to the interface definition as documentation.
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I09f82afc07f2a3281787b0adf7f6841be23621e9
diff --git a/xyz/openbmc_project/ObjectMapper.interface.yaml b/xyz/openbmc_project/ObjectMapper.interface.yaml
index 250cddf..f76d48d 100644
--- a/xyz/openbmc_project/ObjectMapper.interface.yaml
+++ b/xyz/openbmc_project/ObjectMapper.interface.yaml
@@ -22,6 +22,8 @@
type: dict[string,array[string]]
description: >
A dictionary of service -> implemented interface(s).
+ errors:
+ - xyz.openbmc_project.Common.Error.ResourceNotFound
- name: GetAncestors
description: >
Obtain a dictionary of ancestor -> services where ancestor is an
@@ -41,6 +43,8 @@
type: dict[path,dict[string,array[string]]]
description: >
A dictionary of ancestor -> services.
+ errors:
+ - xyz.openbmc_project.Common.Error.ResourceNotFound
- name: GetSubTree
description: >
Obtain a dictionary of path -> services where path is in
@@ -65,6 +69,8 @@
type: dict[path,dict[string,array[string]]]
description: >
A dictionary of path -> services.
+ errors:
+ - xyz.openbmc_project.Common.Error.ResourceNotFound
- name: GetSubTreePaths
description: >
Obtain an array of paths where array elements are in subtree.
@@ -87,3 +93,5 @@
type: array[path]
description: >
An array of paths.
+ errors:
+ - xyz.openbmc_project.Common.Error.ResourceNotFound