ray/dashboard/modules/snapshot/snapshot_schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "http://github.com/ray-project/ray/dashboard/modules/snapshot/snapshot_schema.json",
  "type": "object",
  "properties": {
    "result": {
      "type": "boolean"
    },
    "msg": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "properties": {
        "snapshot": {
          "type": "object",
          "properties": {
            "ray_version": {
              "type": "string"
            },
            "ray_commit": {
              "type": "string"
            },
            "jobs": {
              "type": "object",
              "patternProperties": {
                "[0-9a-f]*": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": ["string", "null"]
                    },
                    "status_message": {
                      "type": ["string", "null"]
                    },
                    "isDead": {
                      "type": "boolean"
                    },
                    "startTime": {
                      "type": "integer"
                    },
                    "endTime": {
                      "type": "integer"
                    },
                    "config": {
                      "type": "object",
                      "properties": {
                        "namespace": {
                          "type": "string"
                        },
                        "metadata": {
                          "type": "object"
                        },
                        "runtimeEnv": {
                          "type": "object"
                        }
                      },
                      "required": [
                        "namespace",
                        "metadata",
                        "runtimeEnv"
                      ]
                    }
                  },
                  "required": [
                    "isDead",
                    "startTime",
                    "endTime",
                    "config"
                  ]
                }
              }
            },
            "actors": {
              "type": "object",
              "patternProperties": {
                "[0-9a-f]*": {
                  "jobId": {
                    "type": "string"
                  },
                  "state": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  },
                  "namespace": {
                    "type": "string"
                  },
                  "runtimeEnv": {
                    "type": "string"
                  },
                  "startTime": {
                    "type": "integer"
                  },
                  "endTime": {
                    "type": "integer"
                  },
                  "isDetached": {
                    "type": "boolean"
                  },
                  "resources": {
                    "type": "object",
                    "properties": {
                      ".*": {
                        "type": "number"
                      }
                    }
                  },
                  "actorClass": {
                    "type": "string"
                  },
                  "currentWorkerId": {
                    "type": "string"
                  },
                  "currentRayletId": {
                    "type": "string"
                  },
                  "ipAddress": {
                    "type": "string"
                  },
                  "port": {
                    "type": "integer"
                  },
                  "metadata": {
                    "type": "object",
                    "properties": {
                      "serve": {
                        "type": "object",
                        "properties": {
                          "deploymentName": {
                            "type": "string"
                          },
                          "replicaTag": {
                            "type": "string"
                          },
                          "version": {
                            "type": "string"
                          }
                        },
                        "required": [
                          "deploymentName",
                          "replicaTag",
                          "version"
                        ]
                      }
                    }
                  },
                  "required": [
                    "jobId",
                    "state",
                    "name",
                    "namespace",
                    "runtimeEnv",
                    "startTime",
                    "endTime",
                    "isDetached",
                    "resources",
                    "currentWorkerId",
                    "currentRayletId",
                    "actorClass",
                    "ipAddress",
                    "port"
                  ]
                }
              }
            },
            "deployments": {
              "type": "object",
              "patternProperties": {
                "[0-9a-f]*": {
                  "type": "object",
                  "properties": {
                    "className": {
                      "type": "string"
                    },
                    "endTime": {
                      "type": "integer"
                    },
                    "startTime": {
                      "type": "integer"
                    },
                    "httpRoute": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "namespace": {
                      "type": "string"
                    },
                    "rayJobId": {
                      "type": "string"
                    },
                    "status": {
                      "type": "string"
                    },
                    "version": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "className",
                    "startTime",
                    "endTime",
                    "httpRoute",
                    "name",
                    "namespace",
                    "rayJobId",
                    "status",
                    "version"
                  ]
                }
              }
            }
          },
          "sessionName": {
            "type": "string"
          },
          "required": [
            "rayVersion",
            "rayCommit",
            "jobs",
            "actors",
            "sessionName"
          ]
        }
      },
      "required": [
        "snapshot"
      ]
    }
  },
  "required": [
    "result",
    "msg",
    "data"
  ]
}