treewide: use more specific object_path type
The sdbus++ tool allows the YAML to specify either "path" or
"object_path". Switch to "object_path" everywhere for consistency
and clarity.
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I60c51b2ece5fc4cb23d05ce5151301db3dcddf3a
diff --git a/yaml/com/ibm/VPD/Manager.interface.yaml b/yaml/com/ibm/VPD/Manager.interface.yaml
index ddeacd4..2dfae1b 100644
--- a/yaml/com/ibm/VPD/Manager.interface.yaml
+++ b/yaml/com/ibm/VPD/Manager.interface.yaml
@@ -6,7 +6,7 @@
A method to update the keyword value for a given VPD record.
parameters:
- name: path
- type: path
+ type: object_path
description: >
Path to the D-Bus object that represents the FRU.
- name: record
@@ -43,7 +43,7 @@
ignored on a single node system.
returns:
- name: inventoryList
- type: array[path]
+ type: array[object_path]
description: >
List of all the FRUs D-Bus object paths for the given location
code.
@@ -63,7 +63,7 @@
Location code in expanded format.
returns:
- name: inventoryList
- type: array[path]
+ type: array[object_path]
description: >
List of all the FRUs D-Bus object path for the given location
code.
diff --git a/yaml/xyz/openbmc_project/Association.interface.yaml b/yaml/xyz/openbmc_project/Association.interface.yaml
index 262dfaf..f936bc0 100644
--- a/yaml/xyz/openbmc_project/Association.interface.yaml
+++ b/yaml/xyz/openbmc_project/Association.interface.yaml
@@ -8,6 +8,6 @@
of the object implementing Association.
properties:
- name: Endpoints
- type: array[path]
+ type: array[object_path]
description: >
An array of association endpoints.
diff --git a/yaml/xyz/openbmc_project/Certs/Authority.interface.yaml b/yaml/xyz/openbmc_project/Certs/Authority.interface.yaml
index 98c940c..e081bfa 100644
--- a/yaml/xyz/openbmc_project/Certs/Authority.interface.yaml
+++ b/yaml/xyz/openbmc_project/Certs/Authority.interface.yaml
@@ -13,7 +13,7 @@
returns:
- name: path
- type: path
+ type: object_path
description: >
The object path of an object that implements, at a minimum,
xyz.openbmc_project.Certs.Entry and xyz.openbmc_project.Object.Delete
diff --git a/yaml/xyz/openbmc_project/Control/FanRedundancy.interface.yaml b/yaml/xyz/openbmc_project/Control/FanRedundancy.interface.yaml
index 17e956a..235a95b 100644
--- a/yaml/xyz/openbmc_project/Control/FanRedundancy.interface.yaml
+++ b/yaml/xyz/openbmc_project/Control/FanRedundancy.interface.yaml
@@ -8,7 +8,7 @@
description: >
Number of fans in error state before redundancy is lost.
- name: Collection
- type: array[path]
+ type: array[object_path]
flags:
- const
description: >
diff --git a/yaml/xyz/openbmc_project/HardwareIsolation/Create.interface.yaml b/yaml/xyz/openbmc_project/HardwareIsolation/Create.interface.yaml
index eed4373..0262660 100644
--- a/yaml/xyz/openbmc_project/HardwareIsolation/Create.interface.yaml
+++ b/yaml/xyz/openbmc_project/HardwareIsolation/Create.interface.yaml
@@ -12,7 +12,7 @@
for example, the user voluntarily tried to isolate hardware.
parameters:
- name: IsolateHardware
- type: path
+ type: object_path
description: >
The hardware inventory path which is needs to isolate.
- name: Severity
@@ -21,7 +21,7 @@
The severity of hardware isolation.
returns:
- name: Path
- type: path
+ type: object_path
description: >
The path of created xyz.openbmc_project.HardwareIsolation.Entry
object.
@@ -43,7 +43,7 @@
the isolation.
parameters:
- name: IsolateHardware
- type: path
+ type: object_path
description: >
The hardware inventory path which is needs to isolate.
- name: Severity
@@ -51,12 +51,12 @@
description: >
The severity of hardware isolation.
- name: BmcErrorLog
- type: path
+ type: object_path
description: >
The BMC error log caused the isolation of hardware.
returns:
- name: Path
- type: path
+ type: object_path
description: >
The path of created xyz.openbmc_project.HardwareIsolation.Entry
object.
diff --git a/yaml/xyz/openbmc_project/Inventory/Manager.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Manager.interface.yaml
index 6c791ee..5045507 100644
--- a/yaml/xyz/openbmc_project/Inventory/Manager.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Manager.interface.yaml
@@ -12,6 +12,6 @@
state managed.
parameters:
- name: object
- type: dict[path,dict[string,dict[string,variant[boolean,size,int64,string,array[byte]]]]]
+ type: dict[object_path,dict[string,dict[string,variant[boolean,size,int64,string,array[byte]]]]]
description: >
A dictionary of fully enumerated items to be managed.
diff --git a/yaml/xyz/openbmc_project/Logging/IPMI.interface.yaml b/yaml/xyz/openbmc_project/Logging/IPMI.interface.yaml
index 517a346..e7c4a08 100644
--- a/yaml/xyz/openbmc_project/Logging/IPMI.interface.yaml
+++ b/yaml/xyz/openbmc_project/Logging/IPMI.interface.yaml
@@ -26,7 +26,7 @@
description: >
The text to log for the event.
- name: Path
- type: path
+ type: object_path
description: >
The object path that is generating the SEL entry.
- name: SELData
@@ -60,7 +60,7 @@
description: >
The text to log for the event.
- name: Path
- type: path
+ type: object_path
description: >
The object path that is generating the SEL entry.
- name: SELData
diff --git a/yaml/xyz/openbmc_project/ObjectMapper.interface.yaml b/yaml/xyz/openbmc_project/ObjectMapper.interface.yaml
index b87015d..45faf75 100644
--- a/yaml/xyz/openbmc_project/ObjectMapper.interface.yaml
+++ b/yaml/xyz/openbmc_project/ObjectMapper.interface.yaml
@@ -10,7 +10,7 @@
for the given path.
parameters:
- name: path
- type: path
+ type: object_path
description: >
The object path for which the result should be fetched.
- name: interfaces
@@ -31,7 +31,7 @@
GetObject method.
parameters:
- name: path
- type: path
+ type: object_path
description: >
The path for which the result should be fetched.
- name: interfaces
@@ -40,7 +40,7 @@
An array of result set constraining interfaces.
returns:
- name: ancestors
- type: dict[path,dict[string,array[string]]]
+ type: dict[object_path,dict[string,array[string]]]
description: >
A dictionary of ancestor -> services.
errors:
@@ -52,7 +52,7 @@
GetObject method.
parameters:
- name: subtree
- type: path
+ type: object_path
description: >
The subtree path for which the result should be fetched.
- name: depth
@@ -66,7 +66,7 @@
An array of result set constraining interfaces.
returns:
- name: objects
- type: dict[path,dict[string,array[string]]]
+ type: dict[object_path,dict[string,array[string]]]
description: >
A dictionary of path -> services.
errors:
@@ -76,7 +76,7 @@
Obtain an array of paths where array elements are in subtree.
parameters:
- name: subtree
- type: path
+ type: object_path
description: >
The subtree path for which the result should be fetched.
- name: depth
@@ -90,7 +90,7 @@
An array of result set constraining interfaces.
returns:
- name: paths
- type: array[path]
+ type: array[object_path]
description: >
An array of paths.
errors:
@@ -101,11 +101,11 @@
an association endpoint on associatedPath
parameters:
- name: associatedPath
- type: path
+ type: object_path
description: >
The path where the associated endpoint is fetched from.
- name: subtree
- type: path
+ type: object_path
description: >
The subtree path for which the result should be fetched.
- name: depth
@@ -119,7 +119,7 @@
An array of result set constraining interfaces.
returns:
- name: objects
- type: dict[path,dict[string,array[string]]]
+ type: dict[object_path,dict[string,array[string]]]
description: >
A dictionary of path -> services.
errors:
@@ -130,11 +130,11 @@
an association endpoint on associatedPath
parameters:
- name: associatedPath
- type: path
+ type: object_path
description: >
The path where the associated endpoint is fetched from.
- name: subtree
- type: path
+ type: object_path
description: >
The subtree path for which the result should be fetched.
- name: depth
@@ -148,7 +148,7 @@
An array of result set constraining interfaces.
returns:
- name: paths
- type: array[path]
+ type: array[object_path]
description: >
An array of paths.
errors:
diff --git a/yaml/xyz/openbmc_project/User/PrivilegeMapper.interface.yaml b/yaml/xyz/openbmc_project/User/PrivilegeMapper.interface.yaml
index ef28b45..3e84ecd 100644
--- a/yaml/xyz/openbmc_project/User/PrivilegeMapper.interface.yaml
+++ b/yaml/xyz/openbmc_project/User/PrivilegeMapper.interface.yaml
@@ -36,7 +36,7 @@
https://github.com/openbmc/docs/blob/master/architecture/user-management.md
returns:
- name: Path
- type: path
+ type: object_path
description: >
The path for the created privilege mapping object.