blob: 9cde19a3aab70a61e8a8477646f9becd9d49fc36 [file] [log] [blame]
Brad Bishop938b1d52016-11-01 12:47:24 -05001description: >
2 Implement to provide DBus service lookup features.
3
4 Any OpenBMC implementation must provide exactly one implementation of
5 xyz.openbmc_project.ObjectMapper on /xyz/openbmc_project/ObjectMapper.
6methods:
7 - name: GetObject
8 description: >
Patrick Williamsa1347412022-12-06 10:56:22 -06009 Obtain a dictionary of service -> implemented interface(s) for the
10 given path.
Brad Bishop938b1d52016-11-01 12:47:24 -050011 parameters:
Patrick Williams8da396c2022-03-14 14:21:02 -050012 - name: path
Patrick Williamsb78a0702022-10-24 12:32:56 -050013 type: object_path
Patrick Williams8da396c2022-03-14 14:21:02 -050014 description: >
15 The object path for which the result should be fetched.
16 - name: interfaces
17 type: array[string]
18 description: >
19 An array of result set constraining interfaces.
Brad Bishop938b1d52016-11-01 12:47:24 -050020 returns:
Patrick Williams8da396c2022-03-14 14:21:02 -050021 - name: services
22 type: dict[string,array[string]]
23 description: >
24 A dictionary of service -> implemented interface(s).
Patrick Williamsd37091a2020-11-11 14:24:21 -060025 errors:
Patrick Williams8da396c2022-03-14 14:21:02 -050026 - xyz.openbmc_project.Common.Error.ResourceNotFound
Brad Bishop938b1d52016-11-01 12:47:24 -050027 - name: GetAncestors
28 description: >
29 Obtain a dictionary of ancestor -> services where ancestor is an
Patrick Williamsa1347412022-12-06 10:56:22 -060030 ancestor of path and services is of the type returned by the GetObject
31 method.
Brad Bishop938b1d52016-11-01 12:47:24 -050032 parameters:
Patrick Williams8da396c2022-03-14 14:21:02 -050033 - name: path
Patrick Williamsb78a0702022-10-24 12:32:56 -050034 type: object_path
Patrick Williams8da396c2022-03-14 14:21:02 -050035 description: >
36 The path for which the result should be fetched.
37 - name: interfaces
38 type: array[string]
39 description: >
40 An array of result set constraining interfaces.
Brad Bishop938b1d52016-11-01 12:47:24 -050041 returns:
Patrick Williams8da396c2022-03-14 14:21:02 -050042 - name: ancestors
Patrick Williamsb78a0702022-10-24 12:32:56 -050043 type: dict[object_path,dict[string,array[string]]]
Patrick Williams8da396c2022-03-14 14:21:02 -050044 description: >
45 A dictionary of ancestor -> services.
Patrick Williamsd37091a2020-11-11 14:24:21 -060046 errors:
Patrick Williams8da396c2022-03-14 14:21:02 -050047 - xyz.openbmc_project.Common.Error.ResourceNotFound
Brad Bishop938b1d52016-11-01 12:47:24 -050048 - name: GetSubTree
49 description: >
Patrick Williamsa1347412022-12-06 10:56:22 -060050 Obtain a dictionary of path -> services where path is in sutbtree and
51 services is of the type returned by the GetObject method.
Brad Bishop938b1d52016-11-01 12:47:24 -050052 parameters:
Patrick Williams8da396c2022-03-14 14:21:02 -050053 - name: subtree
Patrick Williamsb78a0702022-10-24 12:32:56 -050054 type: object_path
Patrick Williams8da396c2022-03-14 14:21:02 -050055 description: >
56 The subtree path for which the result should be fetched.
57 - name: depth
58 type: int32
59 description: >
60 The maximum subtree depth for which results should be fetched.
61 For unconstrained fetches use a depth of zero.
62 - name: interfaces
63 type: array[string]
64 description: >
65 An array of result set constraining interfaces.
Brad Bishop938b1d52016-11-01 12:47:24 -050066 returns:
Patrick Williams8da396c2022-03-14 14:21:02 -050067 - name: objects
Patrick Williamsb78a0702022-10-24 12:32:56 -050068 type: dict[object_path,dict[string,array[string]]]
Patrick Williams8da396c2022-03-14 14:21:02 -050069 description: >
70 A dictionary of path -> services.
Patrick Williamsd37091a2020-11-11 14:24:21 -060071 errors:
Patrick Williams8da396c2022-03-14 14:21:02 -050072 - xyz.openbmc_project.Common.Error.ResourceNotFound
Brad Bishop938b1d52016-11-01 12:47:24 -050073 - name: GetSubTreePaths
74 description: >
75 Obtain an array of paths where array elements are in subtree.
76 parameters:
Patrick Williams8da396c2022-03-14 14:21:02 -050077 - name: subtree
Patrick Williamsb78a0702022-10-24 12:32:56 -050078 type: object_path
Patrick Williams8da396c2022-03-14 14:21:02 -050079 description: >
80 The subtree path for which the result should be fetched.
81 - name: depth
82 type: int32
83 description: >
84 The maximum subtree depth for which results should be fetched.
85 For unconstrained fetches use a depth of zero.
86 - name: interfaces
87 type: array[string]
88 description: >
89 An array of result set constraining interfaces.
Brad Bishop938b1d52016-11-01 12:47:24 -050090 returns:
Patrick Williams8da396c2022-03-14 14:21:02 -050091 - name: paths
Patrick Williamsb78a0702022-10-24 12:32:56 -050092 type: array[object_path]
Patrick Williams8da396c2022-03-14 14:21:02 -050093 description: >
94 An array of paths.
Patrick Williamsd37091a2020-11-11 14:24:21 -060095 errors:
Patrick Williams8da396c2022-03-14 14:21:02 -050096 - xyz.openbmc_project.Common.Error.ResourceNotFound
Willy Tu8e56f4c2022-10-11 20:52:59 +000097 - name: GetAssociatedSubTree
98 description: >
Patrick Williamsa1347412022-12-06 10:56:22 -060099 Same as GetSubTree, but only return the dbus paths that are an
100 association endpoint on associatedPath
Willy Tu8e56f4c2022-10-11 20:52:59 +0000101 parameters:
102 - name: associatedPath
Patrick Williamsb78a0702022-10-24 12:32:56 -0500103 type: object_path
Willy Tu8e56f4c2022-10-11 20:52:59 +0000104 description: >
105 The path where the associated endpoint is fetched from.
106 - name: subtree
Patrick Williamsb78a0702022-10-24 12:32:56 -0500107 type: object_path
Willy Tu8e56f4c2022-10-11 20:52:59 +0000108 description: >
109 The subtree path for which the result should be fetched.
110 - name: depth
111 type: int32
112 description: >
113 The maximum subtree depth for which results should be fetched.
114 For unconstrained fetches use a depth of zero.
115 - name: interfaces
116 type: array[string]
117 description: >
118 An array of result set constraining interfaces.
119 returns:
120 - name: objects
Patrick Williamsb78a0702022-10-24 12:32:56 -0500121 type: dict[object_path,dict[string,array[string]]]
Willy Tu8e56f4c2022-10-11 20:52:59 +0000122 description: >
123 A dictionary of path -> services.
124 errors:
125 - xyz.openbmc_project.Common.Error.ResourceNotFound
126 - name: GetAssociatedSubTreePaths
127 description: >
Patrick Williamsa1347412022-12-06 10:56:22 -0600128 Same as GetSubTreePaths, but only return the dbus paths that are an
129 association endpoint on associatedPath
Willy Tu8e56f4c2022-10-11 20:52:59 +0000130 parameters:
131 - name: associatedPath
Patrick Williamsb78a0702022-10-24 12:32:56 -0500132 type: object_path
Willy Tu8e56f4c2022-10-11 20:52:59 +0000133 description: >
134 The path where the associated endpoint is fetched from.
135 - name: subtree
Patrick Williamsb78a0702022-10-24 12:32:56 -0500136 type: object_path
Willy Tu8e56f4c2022-10-11 20:52:59 +0000137 description: >
138 The subtree path for which the result should be fetched.
139 - name: depth
140 type: int32
141 description: >
142 The maximum subtree depth for which results should be fetched.
143 For unconstrained fetches use a depth of zero.
144 - name: interfaces
145 type: array[string]
146 description: >
147 An array of result set constraining interfaces.
148 returns:
149 - name: paths
Patrick Williamsb78a0702022-10-24 12:32:56 -0500150 type: array[object_path]
Willy Tu8e56f4c2022-10-11 20:52:59 +0000151 description: >
152 An array of paths.
153 errors:
154 - xyz.openbmc_project.Common.Error.ResourceNotFound