reformat with latest settings
Reformat with the latest settings from openbmc-build-scripts (and
copy latest config files where appropriate). Fix a few minor
markdownlint issues.
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I55205817c29dc3f182a165ddf9cd5d4e07b90063
diff --git a/yaml/xyz/openbmc_project/PLDM/PDR.interface.yaml b/yaml/xyz/openbmc_project/PLDM/PDR.interface.yaml
index dcdec47..a366203 100644
--- a/yaml/xyz/openbmc_project/PLDM/PDR.interface.yaml
+++ b/yaml/xyz/openbmc_project/PLDM/PDR.interface.yaml
@@ -1,7 +1,7 @@
description: >
- Implement to fetch the PDRs. PDRs are Platform Descriptor
- Records which are the collection of information that includes semantic
- and association information.
+ Implement to fetch the PDRs. PDRs are Platform Descriptor Records which are
+ the collection of information that includes semantic and association
+ information.
This API would be used by PLDM Requester apps on the BMC.
@@ -35,8 +35,8 @@
- name: EntityID
type: uint16
description: >
- A numeric value that represents an entity that can be associated to
- a PLDM state set.
+ A numeric value that represents an entity that can be associated
+ to a PLDM state set.
More information is found at
http://dmtf.org/sites/default/files/standards/documents/DSP0249_1.0.0.pdf
@@ -45,8 +45,8 @@
- name: StateSetId
type: uint16
description: >
- A numeric value that identifies the PLDM State Set that is used with
- this sensor.
+ A numeric value that identifies the PLDM State Set that is used
+ with this sensor.
More information is found at
http://dmtf.org/sites/default/files/standards/documents/DSP0249_1.0.0.pdf
@@ -57,25 +57,25 @@
type: array[array[byte]]
description: >
Array of State Effecter PDRs, where a PDR is an array[byte].
- Multiple PDRs of the format present in table 89 of DSP0248 version
- 1.2.0 are returned. Each of the PDRs returned has the common header
- along with all the other fields in table 89 and 90 of
- DSP0248 of version 1.2.0 .
+ Multiple PDRs of the format present in table 89 of DSP0248
+ version 1.2.0 are returned. Each of the PDRs returned has the
+ common header along with all the other fields in table 89 and 90
+ of DSP0248 of version 1.2.0 .
errors:
- xyz.openbmc_project.Common.Error.ResourceNotFound
- name: FindStateSensorPDR
description: >
- Obtain the state sensor PDR, for the input TID,
- entity ID and state set id. If multiple PLDM entity instances
- (in state sensor PDRs) match the EntityId and StateSetId below,
- all the corresponding state sensor PDRs are returned. More than one PDR
- can be returned for the same state set id.
+ Obtain the state sensor PDR, for the input TID, entity ID and state
+ set id. If multiple PLDM entity instances (in state sensor PDRs) match
+ the EntityId and StateSetId below, all the corresponding state sensor
+ PDRs are returned. More than one PDR can be returned for the same
+ state set id.
- When the PDR for the given input TID, entity id
- and state set id is not found, then the
- xyz.openbmc_project.Common.Error.ResourceNotFound exception will be thrown.
+ When the PDR for the given input TID, entity id and state set id is
+ not found, then the xyz.openbmc_project.Common.Error.ResourceNotFound
+ exception will be thrown.
parameters:
- name: TID
@@ -86,25 +86,28 @@
- name: EntityID
type: uint16
description: >
- A numeric value that represents an entity that can be associated to a PLDM state set.
- More information is found at
- http://dmtf.org/sites/default/files/standards/documents/DSP0249_1.0.0.pdf section 7.
+ A numeric value that represents an entity that can be associated
+ to a PLDM state set. More information is found at
+ http://dmtf.org/sites/default/files/standards/documents/DSP0249_1.0.0.pdf
+ section 7.
- name: StateSetId
type: uint16
description: >
- A numeric value that identifies the PLDM State Set that is used with this sensor.
- More information is found at
- http://dmtf.org/sites/default/files/standards/documents/DSP0249_1.0.0.pdf section 6.
+ A numeric value that identifies the PLDM State Set that is used
+ with this sensor. More information is found at
+ http://dmtf.org/sites/default/files/standards/documents/DSP0249_1.0.0.pdf
+ section 6.
returns:
- name: StateSensorPDR
type: array[array[byte]]
description: >
- Array of State Sensor PDRs, where a PDR is an array[byte]. Multiple PDRs of the
- format present in table 80 of DSP0248 version 1.2.0 are returned. Each of the PDRs
- returned has the common header along with all the other fields in table 80 and 81 of
- DSP0248 of version 1.2.0 .
+ Array of State Sensor PDRs, where a PDR is an array[byte].
+ Multiple PDRs of the format present in table 80 of DSP0248
+ version 1.2.0 are returned. Each of the PDRs returned has the
+ common header along with all the other fields in table 80 and 81
+ of DSP0248 of version 1.2.0 .
errors:
- xyz.openbmc_project.Common.Error.ResourceNotFound