blob: 72e89a1f843356a4c577fd314b5f9ba4ef812c05 [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: >
9 Obtain a dictionary of service -> implemented interface(s)
10 for the given path.
11 parameters:
12 - name: path
Patrick Williams9f6133c2016-12-09 09:29:38 -060013 type: path
Brad Bishop938b1d52016-11-01 12:47:24 -050014 description: >
15 The object path for which the result should be fetched.
Brad Bishopa2560642016-11-01 13:01:19 -050016 - name: interfaces
Patrick Williams9f6133c2016-12-09 09:29:38 -060017 type: array[string]
Brad Bishopa2560642016-11-01 13:01:19 -050018 description: >
19 An array of result set constraining interfaces.
Brad Bishop938b1d52016-11-01 12:47:24 -050020 returns:
21 - name: services
Patrick Williams9f6133c2016-12-09 09:29:38 -060022 type: dict[string,array[string]]
Brad Bishop938b1d52016-11-01 12:47:24 -050023 description: >
24 A dictionary of service -> implemented interface(s).
25 - name: GetAncestors
26 description: >
27 Obtain a dictionary of ancestor -> services where ancestor is an
28 ancestor of path and services is of the type returned by the
29 GetObject method.
30 parameters:
31 - name: path
Patrick Williams9f6133c2016-12-09 09:29:38 -060032 type: path
Brad Bishop938b1d52016-11-01 12:47:24 -050033 description: >
34 The path for which the result should be fetched.
Brad Bishopa2560642016-11-01 13:01:19 -050035 - name: interfaces
Patrick Williams9f6133c2016-12-09 09:29:38 -060036 type: array[string]
Brad Bishopa2560642016-11-01 13:01:19 -050037 description: >
38 An array of result set constraining interfaces.
Brad Bishop938b1d52016-11-01 12:47:24 -050039 returns:
40 - name: ancestors
Patrick Williams9f6133c2016-12-09 09:29:38 -060041 type: dict[path,dict[string,array[string]]]
Brad Bishop938b1d52016-11-01 12:47:24 -050042 description: >
43 A dictionary of ancestor -> services.
44 - name: GetSubTree
45 description: >
46 Obtain a dictionary of path -> services where path is in
47 sutbtree and services is of the type returned by the
48 GetObject method.
49 parameters:
50 - name: subtree
Patrick Williams9f6133c2016-12-09 09:29:38 -060051 type: path
Brad Bishop938b1d52016-11-01 12:47:24 -050052 description: >
53 The subtree path for which the result should be fetched.
54 - name: depth
Patrick Williams9f6133c2016-12-09 09:29:38 -060055 type: int32
Brad Bishop938b1d52016-11-01 12:47:24 -050056 description: >
57 The maximum subtree depth for which results should be fetched.
58 For unconstrained fetches use a depth of zero.
Brad Bishopa2560642016-11-01 13:01:19 -050059 - name: interfaces
Patrick Williams9f6133c2016-12-09 09:29:38 -060060 type: array[string]
Brad Bishopa2560642016-11-01 13:01:19 -050061 description: >
62 An array of result set constraining interfaces.
Brad Bishop938b1d52016-11-01 12:47:24 -050063 returns:
64 - name: objects
Patrick Williams9f6133c2016-12-09 09:29:38 -060065 type: dict[path,dict[string,array[string]]]
Brad Bishop938b1d52016-11-01 12:47:24 -050066 description: >
67 A dictionary of path -> services.
68 - name: GetSubTreePaths
69 description: >
70 Obtain an array of paths where array elements are in subtree.
71 parameters:
72 - name: subtree
Patrick Williams9f6133c2016-12-09 09:29:38 -060073 type: path
Brad Bishop938b1d52016-11-01 12:47:24 -050074 description: >
75 The subtree path for which the result should be fetched.
76 - name: depth
Patrick Williams9f6133c2016-12-09 09:29:38 -060077 type: int32
Brad Bishop938b1d52016-11-01 12:47:24 -050078 description: >
79 The maximum subtree depth for which results should be fetched.
80 For unconstrained fetches use a depth of zero.
Brad Bishopa2560642016-11-01 13:01:19 -050081 - name: interfaces
Patrick Williams9f6133c2016-12-09 09:29:38 -060082 type: array[string]
Brad Bishopa2560642016-11-01 13:01:19 -050083 description: >
84 An array of result set constraining interfaces.
Brad Bishop938b1d52016-11-01 12:47:24 -050085 returns:
86 - name: paths
Patrick Williams9f6133c2016-12-09 09:29:38 -060087 type: array[path]
Brad Bishop938b1d52016-11-01 12:47:24 -050088 description: >
89 An array of paths.
90
91# vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4