| Brad Bishop | 938b1d5 | 2016-11-01 12:47:24 -0500 | [diff] [blame^] | 1 | description: > |
| 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. |
| 6 | methods: |
| 7 | - name: GetObject |
| 8 | description: > |
| 9 | Obtain a dictionary of service -> implemented interface(s) |
| 10 | for the given path. |
| 11 | parameters: |
| 12 | - name: path |
| 13 | type: s # TODO: o |
| 14 | description: > |
| 15 | The object path for which the result should be fetched. |
| 16 | returns: |
| 17 | - name: services |
| 18 | type: a{sas} |
| 19 | description: > |
| 20 | A dictionary of service -> implemented interface(s). |
| 21 | - name: GetAncestors |
| 22 | description: > |
| 23 | Obtain a dictionary of ancestor -> services where ancestor is an |
| 24 | ancestor of path and services is of the type returned by the |
| 25 | GetObject method. |
| 26 | parameters: |
| 27 | - name: path |
| 28 | type: s # TODO: o |
| 29 | description: > |
| 30 | The path for which the result should be fetched. |
| 31 | returns: |
| 32 | - name: ancestors |
| 33 | type: a{sa{sas}} # TODO a{oa{sas}} |
| 34 | description: > |
| 35 | A dictionary of ancestor -> services. |
| 36 | - name: GetSubTree |
| 37 | description: > |
| 38 | Obtain a dictionary of path -> services where path is in |
| 39 | sutbtree and services is of the type returned by the |
| 40 | GetObject method. |
| 41 | parameters: |
| 42 | - name: subtree |
| 43 | type: s # TODO: o |
| 44 | description: > |
| 45 | The subtree path for which the result should be fetched. |
| 46 | - name: depth |
| 47 | type: i |
| 48 | description: > |
| 49 | The maximum subtree depth for which results should be fetched. |
| 50 | For unconstrained fetches use a depth of zero. |
| 51 | returns: |
| 52 | - name: objects |
| 53 | type: a{sa{sas}} # TODO a{oa{sas}} |
| 54 | description: > |
| 55 | A dictionary of path -> services. |
| 56 | - name: GetSubTreePaths |
| 57 | description: > |
| 58 | Obtain an array of paths where array elements are in subtree. |
| 59 | parameters: |
| 60 | - name: subtree |
| 61 | type: s # TODO: o |
| 62 | description: > |
| 63 | The subtree path for which the result should be fetched. |
| 64 | - name: depth |
| 65 | type: i |
| 66 | description: > |
| 67 | The maximum subtree depth for which results should be fetched. |
| 68 | For unconstrained fetches use a depth of zero. |
| 69 | returns: |
| 70 | - name: paths |
| 71 | type: as # TODO ao |
| 72 | description: > |
| 73 | An array of paths. |
| 74 | |
| 75 | # vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4 |