xref: /openbmc/bmcweb/features/redfish/schema/dmtf/json-schema/ResolutionStep.v1_0_1.json (revision f2a8e57ede74a8252100b2281e3f4d170aa69391)

{
    "$id": "http://redfish.dmtf.org/schemas/v1/ResolutionStep.v1_0_1.json",
    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
    "copyright": "Copyright 2014-2024 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
    "definitions": {
        "ResolutionStep": {
            "additionalProperties": false,
            "description": "This type describes a recommended step of the service-defined resolution.",
            "longDescription": "This type shall describe a recommended step of the service-defined resolution.  The set of recommended steps are used to resolve the cause of a log entry, an event, a condition, or an error message.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "ActionParameters": {
                    "description": "The parameters of the action URI for a resolution step.",
                    "items": {
                        "anyOf": [
                            {
                                "$ref": "http://redfish.dmtf.org/schemas/v1/ActionInfo.json#/definitions/Parameters"
                            },
                            {
                                "type": "null"
                            }
                        ]
                    },
                    "longDescription": "This property shall contain the parameters of the action URI for a resolution step.",
                    "type": "array"
                },
                "ActionURI": {
                    "description": "The action URI for a resolution step.",
                    "format": "uri-reference",
                    "longDescription": "This property shall contain the action URI for a resolution step.",
                    "readonly": true,
                    "type": "string"
                },
                "Oem": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
                    "description": "The OEM extension property.",
                    "longDescription": "This property shall contain the OEM extensions.  All values for properties contained in this object shall conform to the Redfish Specification-described requirements."
                },
                "Priority": {
                    "description": "The priority in the set of resolution steps.",
                    "longDescription": "This property shall contain the priority in the set of resolution steps.  The value `0` shall indicate the highest priority.  Increasing values shall represent decreasing priority.  If two or more resolution steps have the same priority, the execution order of the resolution steps shall be in array order.  If a resolution step does not have a priority assignment, the default is 0.  The priority is used to determine the execution order of the resolution steps.",
                    "minimum": 0,
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ]
                },
                "ResolutionType": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/ResolutionType"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The type of the resolution step.",
                    "longDescription": "This property shall contain the type of the resolution step.",
                    "readonly": true
                },
                "RetryCount": {
                    "description": "The number of retries for a resolution step.",
                    "longDescription": "This property shall contain the number of the retries for a resolution step.",
                    "minimum": 0,
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ]
                },
                "RetryIntervalSeconds": {
                    "description": "The interval between retries for a resolution step.",
                    "longDescription": "This property shall contain the interval, in seconds, between the retries for a resolution step.",
                    "minimum": 0,
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "s"
                },
                "TargetComponentURI": {
                    "description": "The target URI of the component for a resolution step.",
                    "format": "uri-reference",
                    "longDescription": "This property shall contain the target URI of the component for a resolution step.  This property shall be present if the `ActionURI` property is not supported.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                }
            },
            "required": [
                "ResolutionType"
            ],
            "type": "object"
        },
        "ResolutionType": {
            "enum": [
                "ContactVendor",
                "ReplaceComponent",
                "FirmwareUpdate",
                "Reset",
                "PowerCycle",
                "ResetToDefaults",
                "CollectDiagnosticData",
                "OEM"
            ],
            "enumDescriptions": {
                "CollectDiagnosticData": "Collect diagnostic data.",
                "ContactVendor": "Contact vendor for service.",
                "FirmwareUpdate": "Perform a firmware update operation.",
                "OEM": "Perform an OEM-defined resolution step.",
                "PowerCycle": "Perform a power cycle operation.",
                "ReplaceComponent": "Replace a component.",
                "Reset": "Perform a reset operation.",
                "ResetToDefaults": "Reset the settings to factory defaults."
            },
            "type": "string"
        }
    },
    "language": "en",
    "owningEntity": "DMTF",
    "release": "2023.3",
    "title": "#ResolutionStep.v1_0_1"
}