xref: /openbmc/sdbusplus/tools/sdbusplus/schemas/events.schema.yaml (revision f5b39215)

$id: https://openbmc-project.xyz/sdbusplus/events.schema.yaml
$schema: https://json-schema.org/draft/2020-12/schema
title: Event and error definitions
type: object
$defs:
    base-event:
        type: object
        properties:
            name:
                type: string
                description:
                    An identifier for the event in UpperCamelCase; used as the
                    class and Redfish Message ID.
            deprecated:
                type: string
                pattern: "^[0-9]+\\.[0-9]+\\.[0-9]+$"
                description:
                    Indicates that the event is now deprecated and should not be
                    created by any OpenBMC software, but is required to still
                    exist for generation in the Redfish Message Registry. The
                    version listed here should be the first version where the
                    error is no longer used.
            metadata:
                type: array
                items:
                    type: object
                    properties:
                        name:
                            type: string
                            pattern: "^[A-Z_][A-Z0-9_]*$"
                            description: The name of the metadata field.
                        description:
                            type: string
                            description:
                                A description of the field for use by
                                developers.
                        type:
                            type: string
                            pattern: "(string)|(size)|(u?int64)|(double)|(object_path)|(enum\\[.*\\])"
                            description: The type of the metadata field.
                        primary:
                            type: boolean
                            description:
                                Set to true when the metadata field is expected
                                to be part of the Redfish `MessageArgs` (and not
                                only in the extended `DiagnosticData`).
                    required:
                        - name
                        - description
                        - type
                minItems: 1
        required:
            - name
    event:
        type: object
        allOf:
            - $ref: "#/$defs/base-event"
            - oneOf:
                  - $ref: "#/$defs/redfish-messages"
                  - $ref: "#/$defs/redfish-map"
    error:
        type: object
        $ref: "#/$defs/event"
        properties:
            severity:
                enum:
                    - emergency
                    - alert
                    - critical
                    - error
                    - warning
                    - notice
                    - informational
                    - debug
                description: The severity using `syslog`-style nomenclature.
            errno:
                type: string
                pattern: "^E[A-Z0-9]+$"
                description: The errno used for this error.
        required:
            - severity
            - errno
    redfish-messages:
        type: object
        properties:
            en:
                $ref: "#/$defs/redfish-lang-message"
                description: English message details.
        required:
            - en
    redfish-lang-message:
        type: object
        description: The message details for any language.
        properties:
            description:
                type: string
                description:
                    A developer-applicable description of the error reported.
                    These form the "description" of the Redfish message.
            message:
                type: string
                description:
                    The end-user message, including placeholders for arguemnts.
            resolution:
                type: string
                description: The end-user resolution.
        required:
            - message
    redfish-map:
        type: object
        properties:
            redfish-mapping:
                type: string
                pattern: "^[A-Z_][a-zA-Z0-9_]*(\\.[A-Z_][a-zA-Z0-9_]*)*$"
                description: Used when a `sdbusplus` event should map to a
                    specific Redfish Message rather than a generated one. This
                    is useful when an internal error has an analog in a
                    standardized registry.

                    When specifying these, the version should be omitted.
        required:
            - redfish-mapping

properties:
    version:
        type: string
        pattern: "^[0-9]+\\.[0-9]+\\.[0-9]+$"
        description:
            The version of the file, which will be used as the Redfish Message
            Registry version.
    errors:
        type: array
        items:
            $ref: "#/$defs/error"
        minItems: 1
    events:
        type: array
        items:
            $ref: "#/$defs/event"
        minItems: 1
required:
    - version