@remit/api-openapi-spec 0.0.11 → 0.0.12

package/openapi.json

@@ -2185,6 +2185,68 @@
         }
       }
     },
+    "/system/update": {
+      "get": {
+        "operationId": "SystemOperations_getSystemUpdate",
+        "description": "Read the self-update resource: the running version, the outcome of the most recent manifest check, and the state of the current or last run. Owner-only, and absent (404) unless a manifest URL is configured (RFC 037 D7, D8).",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "The request has succeeded.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/RemitImap.SystemUpdateResponse"
+                }
+              }
+            }
+          }
+        },
+        "x-amazon-apigateway-integration": {
+          "type": "aws_proxy",
+          "httpMethod": "POST",
+          "passthroughBehavior": "when_no_match",
+          "uri": {
+            "Fn::Sub": "arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:{{HandlerFunctionName}}/invocations"
+          }
+        }
+      },
+      "post": {
+        "operationId": "SystemOperations_applySystemUpdate",
+        "description": "Request installation of a specific release. Writes the request to the control seam and returns 202 with the same resource, including a runId. 409 when a run is in flight, 422 when the target is not the manifest's version. Owner-only, and absent (404) unless a manifest URL is configured (RFC 037 D7, D8).",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "The request has succeeded.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/RemitImap.SystemUpdateResponse"
+                }
+              }
+            }
+          }
+        },
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/RemitImap.ApplyUpdateInput"
+              }
+            }
+          }
+        },
+        "x-amazon-apigateway-integration": {
+          "type": "aws_proxy",
+          "httpMethod": "POST",
+          "passthroughBehavior": "when_no_match",
+          "uri": {
+            "Fn::Sub": "arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:{{HandlerFunctionName}}/invocations"
+          }
+        }
+      }
+    },
     "/threads": {
       "get": {
         "operationId": "UnifiedThreadOperations_listAllThreads",
@@ -3039,6 +3101,19 @@
         ],
         "description": "Address roles in message headers per RFC 2822 Sections 3.6.2 and 3.6.3"
       },
+      "RemitImap.ApplyUpdateInput": {
+        "type": "object",
+        "required": [
+          "targetVersion"
+        ],
+        "properties": {
+          "targetVersion": {
+            "type": "string",
+            "description": "The release version to install, `vX.Y.Z`"
+          }
+        },
+        "description": "Request to install a specific release. `targetVersion` must equal the version the latest check reported; the backend passes exactly this one field across the control seam and resolves nothing else (RFC 037 R6)."
+      },
       "RemitImap.AppointFolderRoleInput": {
         "type": "object",
         "required": [
@@ -5434,6 +5509,190 @@
         },
         "description": "Sync trigger response"
       },
+      "RemitImap.SystemUpdateCheck": {
+        "type": "object",
+        "required": [
+          "status"
+        ],
+        "properties": {
+          "status": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RemitImap.SystemUpdateCheckStatus"
+              }
+            ],
+            "description": "Outcome of the most recent manifest check"
+          },
+          "lastCheckedAt": {
+            "type": "string",
+            "description": "When the manifest was last fetched, ISO 8601. Absent when the check is disabled."
+          },
+          "latestVersion": {
+            "type": "string",
+            "description": "Latest release version named by the manifest, `vX.Y.Z`. Present when status is `ok`."
+          },
+          "publishedAt": {
+            "type": "string",
+            "description": "Publication date of the latest release, ISO 8601. Present when status is `ok`."
+          },
+          "summary": {
+            "type": "string",
+            "description": "One authored sentence describing the latest release. Present when status is `ok`."
+          },
+          "releaseNotesUrl": {
+            "type": "string",
+            "description": "URL of the release notes for the latest release. Present when status is `ok`."
+          },
+          "updateAvailable": {
+            "type": "boolean",
+            "description": "Whether the latest release is newer than the running version. Present when status is `ok`."
+          },
+          "schemaVersion": {
+            "type": "integer",
+            "format": "int32",
+            "description": "Schema version of the latest release, from the manifest. Compared against `currentSchemaVersion` to derive whether applying the release runs a migration. Absent when the manifest does not carry it, so a state file written before this field existed still validates."
+          },
+          "error": {
+            "type": "string",
+            "description": "Plain sentence naming why the check failed. Present when status is `failed`."
+          }
+        },
+        "description": "The most recent manifest check. The check block is independent of the run block: a failed check never renders as a failed update. On `failed` the version fields are absent and an `error` sentence explains why; on `disabled` only the status is present."
+      },
+      "RemitImap.SystemUpdateCheckStatus": {
+        "type": "string",
+        "enum": [
+          "ok",
+          "failed",
+          "disabled"
+        ],
+        "description": "Outcome of the most recent manifest check. `ok` when a manifest was fetched and validated, `failed` when it could not be, `disabled` when no manifest URL is configured or no check has ever run (RFC 037 D8)."
+      },
+      "RemitImap.SystemUpdateOutcome": {
+        "type": "string",
+        "enum": [
+          "succeeded",
+          "rolledBack",
+          "rollbackFailed",
+          "abandoned"
+        ],
+        "description": "Terminal outcome of an update run. `null` while a run is in flight; `succeeded` when the new version committed, `rolledBack` when it did not and the previous version was restored, `rollbackFailed` when the restore itself failed and an operator shell is needed, `abandoned` when the run ended having changed nothing (RFC 037 R11)."
+      },
+      "RemitImap.SystemUpdatePhase": {
+        "type": "string",
+        "enum": [
+          "checking",
+          "pulling",
+          "snapshotting",
+          "stopping",
+          "starting",
+          "verifying",
+          "committing",
+          "rollingBack",
+          "recovering"
+        ],
+        "description": "Phase of an update run. Advances through the atomic update sequence; `checking` before anything is pulled, `committing` once the new version has answered the gate (RFC 037 R9, R11)."
+      },
+      "RemitImap.SystemUpdateResponse": {
+        "type": "object",
+        "required": [
+          "currentVersion",
+          "check",
+          "run"
+        ],
+        "properties": {
+          "currentVersion": {
+            "type": "string",
+            "description": "The version the instance is currently running, `vX.Y.Z` (or a non-release tag such as `latest`)"
+          },
+          "currentSchemaVersion": {
+            "type": "integer",
+            "format": "int32",
+            "description": "Schema version the running instance is on, written by the wrapper at check time. The consent UI derives that applying a release runs a migration from `check.schemaVersion` being greater than this. Absent when unknown, so a state file written before this field existed still validates."
+          },
+          "check": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RemitImap.SystemUpdateCheck"
+              }
+            ],
+            "description": "The most recent manifest check"
+          },
+          "run": {
+            "type": "object",
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RemitImap.SystemUpdateRun"
+              }
+            ],
+            "nullable": true,
+            "description": "The current or last update run, or `null` when no run has ever started"
+          }
+        },
+        "description": "The self-update resource: the running version, the outcome of the most recent manifest check, and the state of the current or last run. One read serves every interface state. The check block and the run block are independent by construction (RFC 037 D7)."
+      },
+      "RemitImap.SystemUpdateRun": {
+        "type": "object",
+        "required": [
+          "runId",
+          "fromVersion",
+          "targetVersion",
+          "phase",
+          "outcome",
+          "startedAt",
+          "updatedAt",
+          "message",
+          "logCommand"
+        ],
+        "properties": {
+          "runId": {
+            "type": "string",
+            "description": "Opaque id of this run; the client persists it and treats subsequent request failures as an in-progress apply until the surface answers"
+          },
+          "fromVersion": {
+            "type": "string",
+            "description": "Version the run started from, `vX.Y.Z`"
+          },
+          "targetVersion": {
+            "type": "string",
+            "description": "Version the run is installing, `vX.Y.Z`"
+          },
+          "phase": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RemitImap.SystemUpdatePhase"
+              }
+            ],
+            "description": "Phase the run is in"
+          },
+          "outcome": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RemitImap.SystemUpdateOutcome"
+              }
+            ],
+            "nullable": true,
+            "description": "Terminal outcome, or `null` while the run is in flight"
+          },
+          "startedAt": {
+            "type": "string",
+            "description": "When the run started, ISO 8601"
+          },
+          "updatedAt": {
+            "type": "string",
+            "description": "When the run state was last written, ISO 8601"
+          },
+          "message": {
+            "type": "string",
+            "description": "Plain sentence naming the current cause, rendered to the operator verbatim"
+          },
+          "logCommand": {
+            "type": "string",
+            "description": "A command that can be pasted into a shell to see more, rendered to the operator verbatim"
+          }
+        },
+        "description": "The current or last update run. `null` when no run has ever started. `outcome` is `null` while a run is in flight. `message` and `logCommand` are rendered to the operator verbatim: a plain sentence naming the cause and a command that can be pasted into a shell to see more (RFC 037 Interface)."
+      },
       "RemitImap.TestConnectionInput": {
         "type": "object",
         "required": [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/api-openapi-spec",
-  "version": "0.0.11",
+  "version": "0.0.12",
   "description": "Remit API OpenAPI 3 document, generated from TypeSpec.",
   "exports": {
     ".": "./openapi.json",