Require explicitly clearing old update status before starting a new one

oxidecomputer · Dec 8, 2023 · 8a65c20 · 8a65c20
1 parent 865d281
commit 8a65c20
Show file tree

Hide file tree

Showing 3 changed files with 333 additions and 45 deletions.
diff --git a/openapi/sled-agent.json b/openapi/sled-agent.json
@@ -69,7 +69,7 @@
     "/boot-disk/{boot_disk}/os/write/status": {
       "get": {
         "summary": "Get the status of writing a new host OS",
-        "operationId": "host_os_write_status",
+        "operationId": "host_os_write_status_get",
         "parameters": [
           {
             "in": "path",
@@ -100,6 +100,42 @@
         }
       }
     },
+    "/boot-disk/{boot_disk}/os/write/status/{update_id}": {
+      "delete": {
+        "summary": "Clear the status of a completed write of a new host OS",
+        "operationId": "host_os_write_status_delete",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "boot_disk",
+            "required": true,
+            "schema": {
+              "$ref": "#/components/schemas/M2Slot"
+            }
+          },
+          {
+            "in": "path",
+            "name": "update_id",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "format": "uuid"
+            }
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "resource updated"
+          },
+          "4XX": {
+            "$ref": "#/components/responses/Error"
+          },
+          "5XX": {
+            "$ref": "#/components/responses/Error"
+          }
+        }
+      }
+    },
     "/cockroachdb": {
       "post": {
         "summary": "Initializes a CockroachDB cluster",
@@ -2297,7 +2333,7 @@
         "description": "Status of an update to a boot disk OS.",
         "oneOf": [
           {
-            "description": "No update has been started for this disk since this server started.",
+            "description": "No update has been started for this disk, or any previously-started update has completed and had its status cleared.",
             "type": "object",
             "properties": {
               "status": {