yaml: format with prettier
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I193f690f3612fe72ec69030f81f4d5096a761601
diff --git a/yaml/xyz/openbmc_project/Dump/Create.interface.yaml b/yaml/xyz/openbmc_project/Dump/Create.interface.yaml
index 3daaf2a..f20270a 100644
--- a/yaml/xyz/openbmc_project/Dump/Create.interface.yaml
+++ b/yaml/xyz/openbmc_project/Dump/Create.interface.yaml
@@ -9,41 +9,40 @@
systems the instance number can be added to the path to differentiate,
for example /xyz/openbmc_project/dump/<dump type><instance-id>.
-
methods:
- name: CreateDump
description: >
Method to create a manual Dump.
parameters:
- - name: AdditionalData
- type: dict[string, variant[string,uint64]]
- description: >
- The additional data, if any, for initiating the dump.
- The key in this case should be an implementation
- specific enum defined for the specific type of dump
- either in xyz or in a domain.
- The values can be either a string or a 64 bit number.
- The enum-format string is required to come from a
- parallel class with this specific Enum name.
- All of the Enum strings should be in the format
- 'domain.Dump.Create.CreateParameters.ParamName'.
- e.g.:
- {
- "key1": "value1",
- "key2": "value2"
- }
- ends up in AdditionaData like:
- ["KEY1=value1", "KEY2=value2"]
+ - name: AdditionalData
+ type: dict[string, variant[string,uint64]]
+ description: >
+ The additional data, if any, for initiating the dump.
+ The key in this case should be an implementation
+ specific enum defined for the specific type of dump
+ either in xyz or in a domain.
+ The values can be either a string or a 64 bit number.
+ The enum-format string is required to come from a
+ parallel class with this specific Enum name.
+ All of the Enum strings should be in the format
+ 'domain.Dump.Create.CreateParameters.ParamName'.
+ e.g.:
+ {
+ "key1": "value1",
+ "key2": "value2"
+ }
+ ends up in AdditionaData like:
+ ["KEY1=value1", "KEY2=value2"]
returns:
- - name: Path
- type: object_path
- description: >
- The object path of the object that implements
- xyz.openbmc_project.Common.Progress to track the progress
- of the dump
+ - name: Path
+ type: object_path
+ description: >
+ The object path of the object that implements
+ xyz.openbmc_project.Common.Progress to track the progress
+ of the dump
errors:
- - xyz.openbmc_project.Common.File.Error.Write
- - xyz.openbmc_project.Dump.Create.Error.Disabled
- - xyz.openbmc_project.Dump.Create.Error.QuotaExceeded
- - xyz.openbmc_project.Common.Error.NotAllowed
- - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.Common.File.Error.Write
+ - xyz.openbmc_project.Dump.Create.Error.Disabled
+ - xyz.openbmc_project.Dump.Create.Error.QuotaExceeded
+ - xyz.openbmc_project.Common.Error.NotAllowed
+ - xyz.openbmc_project.Common.Error.InvalidArgument
diff --git a/yaml/xyz/openbmc_project/Dump/Entry.interface.yaml b/yaml/xyz/openbmc_project/Dump/Entry.interface.yaml
index 4e0a109..a71cefa 100644
--- a/yaml/xyz/openbmc_project/Dump/Entry.interface.yaml
+++ b/yaml/xyz/openbmc_project/Dump/Entry.interface.yaml
@@ -11,24 +11,24 @@
methods:
- name: InitiateOffload
description: >
- This method initiates the offload of the dump from the dump storage.
- The transfer will be initiated to the target provide. The caller of
- this function should set up a method to transfer and pass the URI to
- to this function. If there is no exceptions the caller can assume the
- transfer is successfully initiated. Once the transfer is completed.
- The application which is transferring the dump should set offloaded
- property to true to indicate offload is completed.
+ This method initiates the offload of the dump from the dump storage.
+ The transfer will be initiated to the target provide. The caller of
+ this function should set up a method to transfer and pass the URI to
+ to this function. If there is no exceptions the caller can assume the
+ transfer is successfully initiated. Once the transfer is completed.
+ The application which is transferring the dump should set offloaded
+ property to true to indicate offload is completed.
parameters:
- - name: OffloadUri
- type: string
- description: >
- The location to offload dump file, error InvalidArgument will be
- returned if the URI is not well formated.
+ - name: OffloadUri
+ type: string
+ description: >
+ The location to offload dump file, error InvalidArgument will be
+ returned if the URI is not well formated.
errors:
- - xyz.openbmc_project.Common.File.Error.Open
- - xyz.openbmc_project.Common.File.Error.Write
- - xyz.openbmc_project.Common.Error.InvalidArgument
- - xyz.openbmc_project.Common.Error.NotAllowed
+ - xyz.openbmc_project.Common.File.Error.Open
+ - xyz.openbmc_project.Common.File.Error.Write
+ - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.Common.Error.NotAllowed
properties:
- name: Size
diff --git a/yaml/xyz/openbmc_project/Dump/NewDump.interface.yaml b/yaml/xyz/openbmc_project/Dump/NewDump.interface.yaml
index 6fa5809..330f1c2 100644
--- a/yaml/xyz/openbmc_project/Dump/NewDump.interface.yaml
+++ b/yaml/xyz/openbmc_project/Dump/NewDump.interface.yaml
@@ -11,19 +11,19 @@
methods:
- name: Notify
description: >
- Create a dump entry based on the parameters.
+ Create a dump entry based on the parameters.
parameters:
- - name: SourceDumpId
- type: uint32
- description: >
- The dump id provided by the source of the dump.
- There are dumps which get generated outside the BMC, like a
- system dump which gets generated and stored in the host memory.
- All dumps will have a unique id but when communicating
- to the source of the dump the SourceDumpId will be used.
- - name: Size
- type: uint64
- description: >
- Size of the dump in bytes
+ - name: SourceDumpId
+ type: uint32
+ description: >
+ The dump id provided by the source of the dump.
+ There are dumps which get generated outside the BMC, like a
+ system dump which gets generated and stored in the host memory.
+ All dumps will have a unique id but when communicating
+ to the source of the dump the SourceDumpId will be used.
+ - name: Size
+ type: uint64
+ description: >
+ Size of the dump in bytes
errors:
- - xyz.openbmc_project.Dump.Create.Error.Disabled
+ - xyz.openbmc_project.Dump.Create.Error.Disabled