format: reformat with latest openbmc-build-scripts
Run all the latest formatters from openbmc-build-scripts. Disable
prettier on the configurations subdirectory because these are
script-formatted already with the repo-local `format-code` extension.
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: Ifa4f2ec6688d60fde2a5f42efc96b6046e9be642
diff --git a/schemas/README.md b/schemas/README.md
index 15bdf81..5b4ee81 100644
--- a/schemas/README.md
+++ b/schemas/README.md
@@ -1,73 +1,71 @@
-Entity manager configuration file schema
-----------------------------------------
+## Entity manager configuration file schema
Entity manager configuration files are JSON documents and can be validated with
-a JSON schema[1]. This document provides an overview of the general structure
-of an entity manager configuration file.
+a JSON schema[1]. This document provides an overview of the general structure of
+an entity manager configuration file.
An entity manager configuration file consists of one or more entity manager
-configurations. This provides flexibility for system designers - the
+configurations. This provides flexibility for system designers - the
configuration data for an entire platform or set of platforms can be expressed
-in a single file, or can be organized into several smaller files. Thus, the
-top most schema describes a single object or an array of objects.
+in a single file, or can be organized into several smaller files. Thus, the top
+most schema describes a single object or an array of objects.
To remain consistent with the OpenBMC CPP source code file name guidelines,
entity manager configuration file and schema file names must be
lower_snake_case.
-A single entity manager configuration
-----------------------------------------
+## A single entity manager configuration
+
At its core entity manager simply exports objects onto DBus when a specific
-event occurs. As such, an entity manager configuration provides a syntax for
+event occurs. As such, an entity manager configuration provides a syntax for
describing the dbus interfaces to export, the object paths on which to add the
-interfaces and the event that should trigger the export. This is accomplished
+interfaces and the event that should trigger the export. This is accomplished
with four properties.
-Type
-----------------------------------------
-The type property identifies the type of the configuration. When exported,
+## Type
+
+The type property identifies the type of the configuration. When exported,
configuration data will be instantiated as grandchildren of
-/xyz/openbmc_project/inventory/system/<Type>. For a comprehensive list of
+/xyz/openbmc_project/inventory/system/<Type>. For a comprehensive list of
supported types, consult the schema (global.json).
-Name
-----------------------------------------
-The name property identifies the name of the configuration. When exported,
+## Name
+
+The name property identifies the name of the configuration. When exported,
configuration data will be instantiated as children of
-/xyz/openbmc_project/inventory/system/<Type>/<Name>. Additionally, any DBus
+/xyz/openbmc_project/inventory/system/<Type>/<Name>. Additionally, any DBus
interfaces listed in openbmc-dbus.json will be added on
/xyz/openbmc_project/inventory/system/<Type>/<Name>.
-Probe
-----------------------------------------
-The probe property describes the event which will cause entity manager to
-export the configuration to DBus, making it available to other applications.
+## Probe
-Exposes
-----------------------------------------
+The probe property describes the event which will cause entity manager to export
+the configuration to DBus, making it available to other applications.
+
+## Exposes
+
The exposes property describes the configuration data at its most specific
-level. The exposes property is an array of heterogeneous configuration data.
+level. The exposes property is an array of heterogeneous configuration data.
Each exposes element has its own schema which is outlined by the subschemas in
-the schemas directory. Each schema must require a type and name (not to be
+the schemas directory. Each schema must require a type and name (not to be
confused with the Type and Name properties of the parent JSON object) property
since entity manager will construct the Dbus interface name and object path
based on those properties:
/xyz/openbmc_project/inventory/system/Board/RiserCard1/<Name>:
- xyz.openbmc_project.Configuration.<Type>:
- <remaining properties defined by exposes subschema>
+xyz.openbmc_project.Configuration.<Type>:
+<remaining properties defined by exposes subschema>
-Adding new exposes property subschema
-----------------------------------------
+## Adding new exposes property subschema
+
New subschema for the exposes property must be added to the schema directory,
-and then referenced from global.json at /definitions/EMExposesElement. Exposes
-element subschema must require a type and name property (the validator will
-fail otherwise) and should explicitly enumerate all properties and use
-additionalProperties so mistakes can be found
-during validation.
+and then referenced from global.json at /definitions/EMExposesElement. Exposes
+element subschema must require a type and name property (the validator will fail
+otherwise) and should explicitly enumerate all properties and use
+additionalProperties so mistakes can be found during validation.
-Adding new Dbus interfaces
-----------------------------------------
+## Adding new Dbus interfaces
+
To export new interfaces on the configuration parent object e.g.:
/xyz/openbmc_project/inventory/system/Board/RiserCard1 add additional subschema
to openbmc-dbus.json.
diff --git a/schemas/global.json b/schemas/global.json
index 6b6382e..b6100bf 100644
--- a/schemas/global.json
+++ b/schemas/global.json
@@ -38,9 +38,7 @@
"when an element does not define a type property."
],
"not": {
- "required": [
- "Type"
- ]
+ "required": ["Type"]
},
"title": "Missing Type"
},
@@ -50,9 +48,7 @@
"when an element does not define a name property."
],
"not": {
- "required": [
- "Name"
- ]
+ "required": ["Name"]
},
"title": "Missing Name"
}
@@ -88,9 +84,7 @@
}
},
"Logging": {
- "enum": [
- "Off"
- ]
+ "enum": ["Off"]
},
"Name": {
"description": [
@@ -130,12 +124,7 @@
"configurations will be instantiated as children of: ",
"/xyz/openbmc_project/configuration/<Type>"
],
- "enum": [
- "Board",
- "Chassis",
- "NVMe",
- "PowerSupply"
- ]
+ "enum": ["Board", "Chassis", "NVMe", "PowerSupply"]
},
"xyz.openbmc_project.Inventory.Decorator.Asset": {
"$ref": "openbmc-dbus.json#/definitions/xyz/openbmc_project/Inventory/Decorator/Asset"
@@ -159,12 +148,7 @@
"$ref": "openbmc-dbus.json#/definitions/xyz/openbmc_project/Inventory/Item/System"
}
},
- "required": [
- "Exposes",
- "Name",
- "Probe",
- "Type"
- ]
+ "required": ["Exposes", "Name", "Probe", "Type"]
}
},
"title": "Entity Manager Configuration File",
diff --git a/schemas/ibm.json b/schemas/ibm.json
index 84f9cd4..36b4370 100644
--- a/schemas/ibm.json
+++ b/schemas/ibm.json
@@ -17,9 +17,7 @@
"type": "string"
},
"Type": {
- "enum": [
- "IBMCFFPSConnector"
- ]
+ "enum": ["IBMCFFPSConnector"]
},
"I2CBus": {
"description": [
@@ -67,7 +65,6 @@
"The recommended entry format is 'manufacturer,model' where",
"the manufacturer is a string describing the name of the",
"manufacturer and model specifies the model number."
-
],
"type": "object",
"properties": {
@@ -75,9 +72,7 @@
"type": "string"
},
"Type": {
- "enum": [
- "IBMCompatibleSystem"
- ]
+ "enum": ["IBMCompatibleSystem"]
},
"Names": {
"type": "array",
@@ -92,11 +87,7 @@
}
}
},
- "required": [
- "Name",
- "Type",
- "Names"
- ]
+ "required": ["Name", "Type", "Names"]
}
}
}
diff --git a/schemas/intel.json b/schemas/intel.json
index 193fc18..fe4c7e7 100644
--- a/schemas/intel.json
+++ b/schemas/intel.json
@@ -19,18 +19,10 @@
"type": "array"
},
"Type": {
- "enum": [
- "IntelFanConnector"
- ]
+ "enum": ["IntelFanConnector"]
}
},
- "required": [
- "Name",
- "Type",
- "Status",
- "Pwm",
- "Tachs"
- ],
+ "required": ["Name", "Type", "Status", "Pwm", "Tachs"],
"type": "object"
}
}
diff --git a/schemas/legacy.json b/schemas/legacy.json
index 47a6c7b..cabfe5c 100644
--- a/schemas/legacy.json
+++ b/schemas/legacy.json
@@ -388,18 +388,12 @@
"$ref": "#/definitions/Types/Type"
}
},
- "required": [
- "Name",
- "Type"
- ],
+ "required": ["Name", "Type"],
"type": "object"
},
"Types": {
"Address": {
- "type": [
- "string",
- "array"
- ]
+ "type": ["string", "array"]
},
"AllowedFailures": {
"type": "number"
@@ -417,16 +411,10 @@
"type": "string"
},
"BridgeGpio": {
- "type": [
- "number",
- "array"
- ]
+ "type": ["number", "array"]
},
"Bus": {
- "type": [
- "string",
- "number"
- ]
+ "type": ["string", "number"]
},
"C1": {
"type": "number"
@@ -461,11 +449,7 @@
"type": "array"
}
},
- "required": [
- "Name",
- "Pwm",
- "Tachs"
- ],
+ "required": ["Name", "Pwm", "Tachs"],
"type": "object"
},
"CpuID": {
@@ -499,9 +483,7 @@
"type": "array"
},
"GpioPolarity": {
- "enum": [
- "Low"
- ]
+ "enum": ["Low"]
},
"Index": {
"type": "number"
@@ -635,10 +617,7 @@
"type": "object"
},
"PresenceGpio": {
- "type": [
- "number",
- "array"
- ]
+ "type": ["number", "array"]
},
"Pwm": {
"type": "number"
@@ -669,10 +648,7 @@
},
"Tachs": {
"items": {
- "type": [
- "number",
- "string"
- ]
+ "type": ["number", "string"]
},
"type": "array"
},
@@ -700,12 +676,7 @@
"type": "number"
}
},
- "required": [
- "Direction",
- "Name",
- "Severity",
- "Value"
- ],
+ "required": ["Direction", "Name", "Severity", "Value"],
"type": "object"
},
"type": "array"
diff --git a/schemas/openbmc-dbus.json b/schemas/openbmc-dbus.json
index 8190b08..184d2f4 100644
--- a/schemas/openbmc-dbus.json
+++ b/schemas/openbmc-dbus.json
@@ -37,9 +37,7 @@
"type": "string"
}
},
- "required": [
- "AssetTag"
- ],
+ "required": ["AssetTag"],
"type": "object"
}
},
@@ -52,9 +50,7 @@
"type": "number"
}
},
- "required": [
- "ProductId"
- ],
+ "required": ["ProductId"],
"type": "object"
}
},
diff --git a/schemas/pid_zone.json b/schemas/pid_zone.json
index 4e4e41a..3905c13 100644
--- a/schemas/pid_zone.json
+++ b/schemas/pid_zone.json
@@ -17,12 +17,7 @@
"type": "string"
}
},
- "required": [
- "FailSafePercent",
- "MinThermalOutput",
- "Name",
- "Type"
- ]
+ "required": ["FailSafePercent", "MinThermalOutput", "Name", "Type"]
}
}
}
diff --git a/schemas/virtual_sensor.json b/schemas/virtual_sensor.json
index 391f695..3584489 100644
--- a/schemas/virtual_sensor.json
+++ b/schemas/virtual_sensor.json
@@ -13,27 +13,19 @@
"type": "object",
"properties": {
"MaxValidInput": {
- "description": [
- "Maximum valid value of an input sensor"
- ],
+ "description": ["Maximum valid value of an input sensor"],
"type": "number"
},
"MaxValue": {
- "description": [
- "Maximum sensor value"
- ],
+ "description": ["Maximum sensor value"],
"$ref": "legacy.json#/definitions/Types/MaxValue"
},
"MinValidInput": {
- "description": [
- "Miniumum valid value of an input sensor"
- ],
+ "description": ["Miniumum valid value of an input sensor"],
"type": "number"
},
"MinValue": {
- "description": [
- "Minimum sensor value"
- ],
+ "description": ["Minimum sensor value"],
"$ref": "legacy.json#/definitions/Types/MinValue"
},
"Name": {
@@ -60,9 +52,7 @@
"The type of calculation this sensor uses."
],
"type": "string",
- "enum": [
- "ModifiedMedian"
- ]
+ "enum": ["ModifiedMedian"]
},
"Units": {
"description": [
@@ -72,12 +62,7 @@
"$ref": "legacy.json#/definitions/Types/Units"
}
},
- "required": [
- "Name",
- "Sensors",
- "Type",
- "Units"
- ]
+ "required": ["Name", "Sensors", "Type", "Units"]
}
}
}