LiveStreamStatus

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/LiveStreamStatus",
  "title": "LiveStreamStatus",
  "type": "object",
  "description": "Status information about a live stream including its stream status and health status.",
  "properties": {
    "streamStatus": {
      "type": "string",
      "description": "The stream's current status.",
      "enum": [
        "active",
        "created",
        "error",
        "inactive",
        "ready"
      ],
      "example": "active"
    },
    "healthStatus": {
      "type": "object",
      "description": "The health status of the stream.",
      "properties": {
        "status": {
          "type": "string",
          "description": "The status code of this stream.",
          "enum": [
            "bad",
            "good",
            "noData",
            "ok",
            "revoked"
          ]
        },
        "lastUpdateTimeSeconds": {
          "type": "integer",
          "format": "int64",
          "description": "The last time this status was updated, as a Unix timestamp."
        },
        "configurationIssues": {
          "type": "array",
          "description": "The configurations issues on this stream.",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "description": "The kind of error happening."
              },
              "severity": {
                "type": "string",
                "description": "How severe this issue is to the stream.",
                "enum": [
                  "error",
                  "info",
                  "warning"
                ]
              },
              "reason": {
                "type": "string",
                "description": "The short-form reason for this issue."
              },
              "description": {
                "type": "string",
                "description": "The long-form description of the issue and how to resolve it."
              }
            }
          }
        }
      },
      "example": "example_value"
    }
  }
}