OpenScan3-Client/openapi_update_status.json at main · OpenScan-org/OpenScan3-Client · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
{
  "openapi": "3.1.0",
  "info": {
    "title": "OpenScan3 Update Status API",
    "version": "1.0.0",
    "description": "Stable update-progress endpoint, served independently of the versioned OpenScan API."
  },
  "servers": [
    {
      "url": "/"
    }
  ],
  "paths": {
    "/update-status": {
      "get": {
        "tags": [
          "system update"
        ],
        "summary": "Get update progress",
        "description": "Returns the current or most recently completed update job and its log output.",
        "operationId": "get_update_progress",
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UpdateProgressResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "UpdateProgressResponse": {
        "type": "object",
        "required": [
          "ok",
          "finished",
          "message",
          "lines",
          "job"
        ],
        "properties": {
          "ok": {
            "type": "boolean",
            "description": "Whether the update job completed successfully."
          },
          "finished": {
            "type": "boolean",
            "description": "Whether the update job has reached a terminal state."
          },
          "message": {
            "type": "string",
            "description": "Human-readable summary of the current update state."
          },
          "lines": {
            "type": "array",
            "description": "Update command output, ordered from oldest to newest.",
            "items": {
              "type": "string"
            }
          },
          "job": {
            "$ref": "#/components/schemas/UpdateProgressJob"
          }
        }
      },
      "UpdateProgressJob": {
        "type": "object",
        "required": [
          "error",
          "status",
          "unit",
          "updated_at"
        ],
        "properties": {
          "error": {
            "type": [
              "string",
              "null"
            ],
            "description": "Error reported by the update job, if any."
          },
          "status": {
            "type": "string",
            "examples": [
              "update_running",
              "update_completed"
            ]
          },
          "unit": {
            "type": "string",
            "description": "Systemd unit responsible for the update job."
          },
          "updated_at": {
            "type": "string",
            "format": "date-time"
          }
        }
      }
    }
  }
}