@remit/api-openapi-spec 0.0.34 → 0.0.36

package/openapi.json

@@ -1440,6 +1440,33 @@
         }
       }
     },
+    "/config/export": {
+      "get": {
+        "operationId": "ConfigOperations_exportConfig",
+        "description": "Export every configured setting for the caller as one versioned JSON document. Contains no credentials: no IMAP/SMTP password and no OAuth token, encrypted or otherwise, and the credential fields are structurally absent rather than blank. The document's own shape is not defined here - it is defined by the published JSON Schema for its `schemaVersion` (build/config-schema/reader-config.v<N>.schema.json), so a file keeps validating independent of this API's models.",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "The request has succeeded.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/RemitImap.ConfigExportResponse"
+                }
+              }
+            }
+          }
+        },
+        "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"
+          }
+        }
+      }
+    },
     "/mailboxes/{mailboxId}/threads": {
       "get": {
         "operationId": "ThreadOperations_listThreads",
@@ -1849,6 +1876,16 @@
                 }
               }
             }
+          },
+          "409": {
+            "description": "The same flat 409 body, for a message whose folder and uid do not name the same message.\n\n`code: \"message_placement_unsettled\"` — the message is mid-move, so its row names the destination folder while its uid still belongs to the source; acting on that pair would hit whatever the destination holds at that uid. `details` carries `accountId`, `messageId` and `reason`, one of: `in_flight` (the move is still running, and the same request succeeds once it confirms) or `unverified` (the move gave up without confirming, so where the message sits is unknown until the folder is resynced).",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ApiError"
+                }
+              }
+            }
           }
         },
         "requestBody": {
@@ -1888,7 +1925,7 @@
             }
           },
           "409": {
-            "description": "An action was refused because the folder role it needs is not settled. The body is flat: `code`, `message` and `details` sit at the top level, which is what the API emits. Clients branch on `code` and word their prompt from `details`, never from `message`.\n\n`code: \"folder_role_unresolved\"` — no folder holds the role this action needs. `details` carries `role`, `accountId`, and `reason`, one of: `none` (the account has no candidate folder), `stale` (the folder the user appointed is gone from the mail server), `unconfirmed` (a folder matches by name, but neither the user nor the server's own flag ever said it holds the role).",
+            "description": "The same flat 409 body, with the two codes this endpoint can answer with.\n\n`code: \"folder_role_unresolved\"` — as everywhere else, with `details` carrying `role`, `accountId` and `reason`.\n\n`code: \"message_placement_unsettled\"` — as `MessagePlacementConflict`, with `details` carrying `accountId`, `messageId` and `reason`.",
             "content": {
               "application/json": {
                 "schema": {
@@ -3988,6 +4025,26 @@
         },
         "description": "Full configuration description including accounts"
       },
+      "RemitImap.ConfigExportResponse": {
+        "type": "object",
+        "required": [
+          "schemaVersion",
+          "document"
+        ],
+        "properties": {
+          "schemaVersion": {
+            "type": "integer",
+            "format": "int32",
+            "description": "Schema version of the document below"
+          },
+          "document": {
+            "type": "object",
+            "additionalProperties": {},
+            "description": "The config document. Opaque here; the JSON Schema for `schemaVersion` is its contract."
+          }
+        },
+        "description": "A configuration export: one versioned document carrying every user decision this instance holds, and no credential."
+      },
       "RemitImap.ConnectionState": {
         "type": "string",
         "enum": [

package/package.json

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