yaml: format with prettier
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I193f690f3612fe72ec69030f81f4d5096a761601
diff --git a/yaml/xyz/openbmc_project/Logging/Create.interface.yaml b/yaml/xyz/openbmc_project/Logging/Create.interface.yaml
index 15b709d..9798b76 100644
--- a/yaml/xyz/openbmc_project/Logging/Create.interface.yaml
+++ b/yaml/xyz/openbmc_project/Logging/Create.interface.yaml
@@ -9,25 +9,25 @@
description: >
Create a xyz.openbmc_project.Logging.Entry object.
parameters:
- - name: Message
- type: string
- description: >
- The Message property of the event entry.
- - name: Severity
- type: enum[xyz.openbmc_project.Logging.Entry.Level]
- description: >
- The Severity property of the event entry.
- - name: AdditionalData
- type: dict[string, string]
- description: >
- The AdditionalData property of the event entry.
- e.g.:
- {
- "key1": "value1",
- "key2": "value2"
- }
- ends up in AdditionaData like:
- ["KEY1=value1", "KEY2=value2"]
+ - name: Message
+ type: string
+ description: >
+ The Message property of the event entry.
+ - name: Severity
+ type: enum[xyz.openbmc_project.Logging.Entry.Level]
+ description: >
+ The Severity property of the event entry.
+ - name: AdditionalData
+ type: dict[string, string]
+ description: >
+ The AdditionalData property of the event entry.
+ e.g.:
+ {
+ "key1": "value1",
+ "key2": "value2"
+ }
+ ends up in AdditionaData like:
+ ["KEY1=value1", "KEY2=value2"]
- name: CreateWithFFDCFiles
description: >
@@ -41,58 +41,57 @@
When the method call is complete the descriptors must be closed and
the files can be deleted if desired.
parameters:
- - name: Message
- type: string
- description: >
- The Message property of the event entry.
- - name: Severity
- type: enum[xyz.openbmc_project.Logging.Entry.Level]
- description: >
- The Severity property of the event entry.
- - name: AdditionalData
- type: dict[string, string]
- description: >
- The AdditionalData property of the event entry.
- e.g.:
- {
- "key1": "value1",
- "key2": "value2"
- }
- ends up in AdditionaData like:
- ["KEY1=value1", "KEY2=value2"]
- - name: FFDC
- type: array[struct[enum[self.FFDCFormat], byte, byte, unixfd]]
- description: >
- File descriptors for any files containing FFDC, along with metadata
- about the contents:
+ - name: Message
+ type: string
+ description: >
+ The Message property of the event entry.
+ - name: Severity
+ type: enum[xyz.openbmc_project.Logging.Entry.Level]
+ description: >
+ The Severity property of the event entry.
+ - name: AdditionalData
+ type: dict[string, string]
+ description: >
+ The AdditionalData property of the event entry.
+ e.g.:
+ {
+ "key1": "value1",
+ "key2": "value2"
+ }
+ ends up in AdditionaData like:
+ ["KEY1=value1", "KEY2=value2"]
+ - name: FFDC
+ type: array[struct[enum[self.FFDCFormat], byte, byte, unixfd]]
+ description: >
+ File descriptors for any files containing FFDC, along with metadata
+ about the contents:
- FFDCFormat- The format type of the contained data.
- subType - The format subtype, used for the 'Custom' type.
- version - The version of the data format, used for the 'Custom'
- type.
- unixfd - The file descriptor to the data file.
+ FFDCFormat- The format type of the contained data.
+ subType - The format subtype, used for the 'Custom' type.
+ version - The version of the data format, used for the 'Custom'
+ type.
+ unixfd - The file descriptor to the data file.
- e.g.:
- [
- {"xyz.openbmc_project.Logging.Create.FFDCFormat.JSON", 0, 0, 5},
- {"xyz.openbmc_project.Logging.Create.FFDCFormat.Custom", 1, 2, 6}
- ]
-
+ e.g.:
+ [
+ {"xyz.openbmc_project.Logging.Create.FFDCFormat.JSON", 0, 0, 5},
+ {"xyz.openbmc_project.Logging.Create.FFDCFormat.Custom", 1, 2, 6}
+ ]
enumerations:
- name: FFDCFormat
description: >
- format types
+ format types
values:
- - name: JSON
- description: >
- Valid fully formed JSON, e.g. {"foo":"bar"}
- - name: CBOR
- description: >
- Valid CBOR (Concise Binary Object Representation)
- - name: Text
- description: >
- ASCII text
- - name: Custom
- description: >
- Something other than the above formats
+ - name: JSON
+ description: >
+ Valid fully formed JSON, e.g. {"foo":"bar"}
+ - name: CBOR
+ description: >
+ Valid CBOR (Concise Binary Object Representation)
+ - name: Text
+ description: >
+ ASCII text
+ - name: Custom
+ description: >
+ Something other than the above formats
diff --git a/yaml/xyz/openbmc_project/Logging/Entry.interface.yaml b/yaml/xyz/openbmc_project/Logging/Entry.interface.yaml
index 991f038..348bb91 100644
--- a/yaml/xyz/openbmc_project/Logging/Entry.interface.yaml
+++ b/yaml/xyz/openbmc_project/Logging/Entry.interface.yaml
@@ -67,38 +67,38 @@
description: >
Possible severity levels for an error log entry.
values:
- - name: Emergency
- description: >
- System is unusable.
- - name: Alert
- description: >
- Should be corrected immediately.
- - name: Critical
- description: >
- Critical condition.
- - name: Error
- description: >
- Error condition.
- - name: Warning
- description: >
- An error may occur if action is not taken.
- - name: Notice
- description: >
- Unusual condition, but not an error.
- - name: Informational
- description: >
- Normal operational message that does not require action.
- - name: Debug
- description: >
- Information useful to developers for debugging the application.
+ - name: Emergency
+ description: >
+ System is unusable.
+ - name: Alert
+ description: >
+ Should be corrected immediately.
+ - name: Critical
+ description: >
+ Critical condition.
+ - name: Error
+ description: >
+ Error condition.
+ - name: Warning
+ description: >
+ An error may occur if action is not taken.
+ - name: Notice
+ description: >
+ Unusual condition, but not an error.
+ - name: Informational
+ description: >
+ Normal operational message that does not require action.
+ - name: Debug
+ description: >
+ Information useful to developers for debugging the application.
methods:
- - name: GetEntry
- description: >
- Returns the file descriptor to the raw Entry file, which is a binary blob.
- The mode of the file descriptor is to be reaad-only.
- returns:
- - name: fd
- type: unixfd
- description: >
- The file descriptor to the Entry file.
+ - name: GetEntry
+ description: >
+ Returns the file descriptor to the raw Entry file, which is a binary blob.
+ The mode of the file descriptor is to be reaad-only.
+ returns:
+ - name: fd
+ type: unixfd
+ description: >
+ The file descriptor to the Entry file.
diff --git a/yaml/xyz/openbmc_project/Logging/IPMI.interface.yaml b/yaml/xyz/openbmc_project/Logging/IPMI.interface.yaml
index 54e24b8..517a346 100644
--- a/yaml/xyz/openbmc_project/Logging/IPMI.interface.yaml
+++ b/yaml/xyz/openbmc_project/Logging/IPMI.interface.yaml
@@ -19,105 +19,105 @@
methods:
- name: IpmiSelAdd
description: >
- Log a system event record type SEL entry.
+ Log a system event record type SEL entry.
parameters:
- - name: Message
- type: string
- description: >
- The text to log for the event.
- - name: Path
- type: path
- description: >
- The object path that is generating the SEL entry.
- - name: SELData
- type: array[byte]
- description: >
- An array of up to 3 bytes of SEL event data.
- - name: Assert
- type: boolean
- description: >
- An indicator if the SEL event is asserting or de-asserting.
- - name: GeneratorID
- type: uint16
- description: >
- The Generator ID of the component requesting the new SEL entry.
- In most cases this will be 0x20 (the BMC Generator ID).
+ - name: Message
+ type: string
+ description: >
+ The text to log for the event.
+ - name: Path
+ type: path
+ description: >
+ The object path that is generating the SEL entry.
+ - name: SELData
+ type: array[byte]
+ description: >
+ An array of up to 3 bytes of SEL event data.
+ - name: Assert
+ type: boolean
+ description: >
+ An indicator if the SEL event is asserting or de-asserting.
+ - name: GeneratorID
+ type: uint16
+ description: >
+ The Generator ID of the component requesting the new SEL entry.
+ In most cases this will be 0x20 (the BMC Generator ID).
returns:
- - name: RecordID
- type: uint16
- description: >
- The Record ID of the new SEL entry.
+ - name: RecordID
+ type: uint16
+ description: >
+ The Record ID of the new SEL entry.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InvalidArgument
- name: AddExtended
description: >
- Log a system event record SEL entry with custom SensorType/EventType.
+ Log a system event record SEL entry with custom SensorType/EventType.
parameters:
- - name: Message
- type: string
- description: >
- The text to log for the event.
- - name: Path
- type: path
- description: >
- The object path that is generating the SEL entry.
- - name: SELData
- type: array[byte]
- description: >
- An array of up to 3 bytes of SEL event data.
- - name: GeneratorID
- type: uint16
- description: >
- The Generator ID of the component requesting the new SEL entry.
- In most cases this will be 0x20 (the BMC Generator ID).
- - name: eventType
- type: byte
- description: >
- Type of trigger for the event and event direction.
- - name: sensorType
- type: byte
- description: >
- Sensor Type Code for sensor that generated the event.
- - name: sensorNum
- type: byte
- description: >
- Number of sensor that generated the event.
+ - name: Message
+ type: string
+ description: >
+ The text to log for the event.
+ - name: Path
+ type: path
+ description: >
+ The object path that is generating the SEL entry.
+ - name: SELData
+ type: array[byte]
+ description: >
+ An array of up to 3 bytes of SEL event data.
+ - name: GeneratorID
+ type: uint16
+ description: >
+ The Generator ID of the component requesting the new SEL entry.
+ In most cases this will be 0x20 (the BMC Generator ID).
+ - name: eventType
+ type: byte
+ description: >
+ Type of trigger for the event and event direction.
+ - name: sensorType
+ type: byte
+ description: >
+ Sensor Type Code for sensor that generated the event.
+ - name: sensorNum
+ type: byte
+ description: >
+ Number of sensor that generated the event.
returns:
- - name: RecordID
- type: uint16
- description: >
- The Record ID of the new SEL entry.
+ - name: RecordID
+ type: uint16
+ description: >
+ The Record ID of the new SEL entry.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InvalidArgument
- name: IpmiSelAddOem
description: >
- Log an OEM record type SEL entry requested from external to the BMC.
+ Log an OEM record type SEL entry requested from external to the BMC.
parameters:
- - name: Message
- type: string
- description: >
- The text to log for the event.
- - name: SELData
- type: array[byte]
- description: >
- An array of up to 13 bytes of SEL event data.
- - name: RecordType
- type: byte
- description: >
- The OEM record type for the SEL entry.
+ - name: Message
+ type: string
+ description: >
+ The text to log for the event.
+ - name: SELData
+ type: array[byte]
+ description: >
+ An array of up to 13 bytes of SEL event data.
+ - name: RecordType
+ type: byte
+ description: >
+ The OEM record type for the SEL entry.
returns:
- - name: RecordID
- type: uint16
- description: >
- The Record ID of the new SEL entry.
+ - name: RecordID
+ type: uint16
+ description: >
+ The Record ID of the new SEL entry.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InvalidArgument
- name: Clear
description: >
- Clear the SEL entries from their storage location.
+ Clear the SEL entries from their storage location.