xref: /openbmc/entity-manager/schemas/global.json (revision d64855f71747d1eea0b36fc05750fb2a3a9835ab)

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$defs": {
        "EMExposesElement": {
            "description": "The exposes property element schema.  An element of the exposes property is always an array where elements are of type exposes entry.",
            "anyOf": [
                {
                    "$ref": "ibm.json#/$defs/PowerModeProperties"
                },
                {
                    "$ref": "ibm.json#/$defs/IBMCompatibleSystem"
                },
                {
                    "$ref": "ibm.json#/$defs/IBMCFFPSConnector"
                },
                {
                    "$ref": "intel.json#/$defs/IntelFanConnector"
                },
                {
                    "$ref": "mctp.json#/$defs/MCTPI2CTarget"
                },
                {
                    "$ref": "mctp.json#/$defs/MCTPI3CTarget"
                },
                {
                    "$ref": "pid.json#/$defs/Pid"
                },
                {
                    "$ref": "pid_zone.json#/$defs/PidZone"
                },
                {
                    "$ref": "satellite_controller.json#/$defs/SatelliteController"
                },
                {
                    "$ref": "stepwise.json#/$defs/Stepwise"
                },
                {
                    "$ref": "legacy.json#/$defs/Aggregate"
                },
                {
                    "$ref": "virtual_sensor.json#/$defs/VirtualSensor"
                },
                {
                    "$ref": "leak_detector.json#/$defs/GPIOLeakDetector"
                },
                {
                    "$ref": "firmware.json#/$defs/XDPE1X2XXFirmware"
                },
                {
                    "description": "Ensure the parent anyOf schema does not validate when an element does not define a type property.",
                    "not": {
                        "required": ["Type"]
                    },
                    "title": "Missing Type"
                },
                {
                    "description": "Ensure the parent anyOf schema does not validate when an element does not define a name property.",
                    "not": {
                        "required": ["Name"]
                    },
                    "title": "Missing Name"
                }
            ],
            "title": "Exposes Property Element"
        },
        "EMConfig": {
            "title": "Entity Manager Configuration",
            "description": "The schema for an entity manager configuration. An entity manager configuration describes an association between a match condition, also known as a probe, and an array of heterogeneous configuration data.  When a probe match occurs, the configuration data is exported to DBus.",
            "additionalProperties": false,
            "type": "object",
            "properties": {
                "Bus": {
                    "type": "string"
                },
                "Exposes": {
                    "description": "The schema for the exposes property. The exposes property must be an array where elements are of type EMExposesElement.  The exposes property is the heterogeneous configuration data exported to DBus upon a probe match.",
                    "type": "array",
                    "items": {
                        "$ref": "#/$defs/EMExposesElement"
                    }
                },
                "Logging": {
                    "enum": ["Off"]
                },
                "Name": {
                    "description": "The schema for the name property.  The name property identifies the configuration.  When exported, the configuration will be instantiated at: /xyz/openbmc_project/configuration/<Type>/<Name>",
                    "type": "string"
                },
                "Probe": {
                    "description": "The schema for an entity manager probe statement. Probes can be a single string or an array. Probes describe a match condition, for example when a DBus property has a specific value. When the match condition occurs, the information described by the Exposes property is exported onto the DBus.",
                    "anyOf": [
                        {
                            "type": "string"
                        },
                        {
                            "type": "array",
                            "items": {
                                "type": "string"
                            }
                        }
                    ]
                },
                "Type": {
                    "title": "Configuration Type",
                    "description": "The schema for the type property. The type property identifies the type of the configuration.  When exported, configurations will be instantiated as children of: /xyz/openbmc_project/configuration/<Type>",
                    "enum": [
                        "Board",
                        "Chassis",
                        "NVMe",
                        "PowerSupply",
                        "CPU",
                        "Cable"
                    ]
                },
                "xyz.openbmc_project.Common.UUID": {
                    "$ref": "openbmc-dbus.json#/$defs/xyz/openbmc_project/Common/UUID"
                },
                "xyz.openbmc_project.Inventory.Decorator.Asset": {
                    "$ref": "openbmc-dbus.json#/$defs/xyz/openbmc_project/Inventory/Decorator/Asset"
                },
                "xyz.openbmc_project.Inventory.Decorator.AssetTag": {
                    "$ref": "openbmc-dbus.json#/$defs/xyz/openbmc_project/Inventory/Decorator/AssetTag"
                },
                "xyz.openbmc_project.Inventory.Decorator.Cable": {
                    "$ref": "openbmc-dbus.json#/$defs/xyz/openbmc_project/Inventory/Decorator/Cable"
                },
                "xyz.openbmc_project.Inventory.Decorator.Compatible": {
                    "$ref": "openbmc-dbus.json#/$defs/xyz/openbmc_project/Inventory/Decorator/Compatible"
                },
                "xyz.openbmc_project.Inventory.Decorator.ManagedHost": {
                    "$ref": "openbmc-dbus.json#/$defs/xyz/openbmc_project/Inventory/Decorator/ManagedHost"
                },
                "xyz.openbmc_project.Inventory.Decorator.Replaceable": {
                    "$ref": "openbmc-dbus.json#/$defs/xyz/openbmc_project/Inventory/Decorator/Replaceable"
                },
                "xyz.openbmc_project.Inventory.Decorator.Slot": {
                    "$ref": "openbmc-dbus.json#/$defs/xyz/openbmc_project/Inventory/Decorator/Slot"
                },
                "xyz.openbmc_project.Inventory.Decorator.Revision": {
                    "$ref": "openbmc-dbus.json#/$defs/xyz/openbmc_project/Inventory/Decorator/Revision"
                },
                "xyz.openbmc_project.Inventory.Item.Board.Motherboard": {
                    "$ref": "openbmc-dbus.json#/$defs/xyz/openbmc_project/Inventory/Item/Board/Motherboard"
                },
                "xyz.openbmc_project.Inventory.Item.Chassis": {
                    "$ref": "openbmc-dbus.json#/$defs/xyz/openbmc_project/Inventory/Item/Chassis"
                },
                "xyz.openbmc_project.Inventory.Item.NetworkInterface": {
                    "$ref": "openbmc-dbus.json#/$defs/xyz/openbmc_project/Inventory/Item/NetworkInterface"
                },
                "xyz.openbmc_project.Inventory.Item.Panel": {
                    "$ref": "openbmc-dbus.json#/$defs/xyz/openbmc_project/Inventory/Item/Panel"
                },
                "xyz.openbmc_project.Inventory.Item.System": {
                    "$ref": "openbmc-dbus.json#/$defs/xyz/openbmc_project/Inventory/Item/System"
                },
                "xyz.openbmc_project.Inventory.Item.Bmc": {
                    "$ref": "openbmc-dbus.json#/$defs/xyz/openbmc_project/Inventory/Item/Bmc"
                },
                "xyz.openbmc_project.Inventory.Item.Storage": {
                    "$ref": "openbmc-dbus.json#/$defs/xyz/openbmc_project/Inventory/Item/Storage"
                },
                "xyz.openbmc_project.Inventory.Item.Accelerator": {
                    "$ref": "openbmc-dbus.json#/$defs/xyz/openbmc_project/Inventory/Item/Accelerator"
                },
                "xyz.openbmc_project.Inventory.Item.Dimm": {
                    "$ref": "openbmc-dbus.json#/$defs/xyz/openbmc_project/Inventory/Item/Dimm"
                }
            },
            "required": ["Exposes", "Name", "Probe", "Type"]
        }
    },
    "title": "Entity Manager Configuration File",
    "description": "The schema for an entity manager configuration file. An entity mananger configuration file can consist of a single object, or an array of objects. Objects must be of type EMConfig.",
    "anyOf": [
        {
            "type": "array",
            "items": {
                "$ref": "#/$defs/EMConfig"
            }
        },
        {
            "$ref": "#/$defs/EMConfig"
        }
    ]
}