@remit/api-openapi-spec 0.0.89 → 0.0.91

package/openapi.json

@@ -9461,7 +9461,7 @@
           "apiKeySaved",
           "enabled",
           "dailyLimit",
-          "savedAt",
+          "sources",
           "usage"
         ],
         "properties": {
@@ -9482,7 +9482,7 @@
           },
           "apiKeySaved": {
             "type": "boolean",
-            "description": "Whether an API key is stored for this provider."
+            "description": "Deprecated: read `sources.apiKey` instead. Whether an API key is saved or inherited from the deployment. Removed once reader-ui reads `sources`."
           },
           "enabled": {
             "type": "boolean",
@@ -9493,10 +9493,13 @@
             "format": "int32",
             "description": "The most classification calls per mail account per UTC day."
           },
-          "savedAt": {
-            "type": "integer",
-            "format": "int64",
-            "description": "When the provider, model, base URL or key was last saved, in epoch milliseconds (UTC)."
+          "sources": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RemitImap.ClassificationSources"
+              }
+            ],
+            "description": "Where each value comes from. A reader overrides one field by saving it, and inherits it again by saving it empty."
           },
           "usage": {
             "type": "array",
@@ -9506,7 +9509,7 @@
             "description": "Today's provider calls, one row per mail account of the account config."
           }
         },
-        "description": "The saved classification provider. The API key itself is never returned."
+        "description": "The classification provider in effect, saved or inherited from the deployment. No API key is ever returned."
       },
       "RemitImap.ClassificationCost": {
         "anyOf": [
@@ -9723,9 +9726,49 @@
           },
           {
             "$ref": "#/components/schemas/RemitImap.ClassificationConfigured"
+          },
+          {
+            "$ref": "#/components/schemas/RemitImap.ClassificationUnrunnable"
           }
         ]
       },
+      "RemitImap.ClassificationSources": {
+        "type": "object",
+        "required": [
+          "presetId",
+          "model",
+          "baseUrl",
+          "apiKey",
+          "enabled",
+          "dailyLimit"
+        ],
+        "properties": {
+          "presetId": {
+            "$ref": "#/components/schemas/RemitImap.ClassificationValueSource"
+          },
+          "model": {
+            "$ref": "#/components/schemas/RemitImap.ClassificationValueSource"
+          },
+          "baseUrl": {
+            "$ref": "#/components/schemas/RemitImap.ClassificationValueSource"
+          },
+          "apiKey": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RemitImap.ClassificationValueSource"
+              }
+            ],
+            "description": "`Saved` for a key the reader saved, `Deployment` for the deployment's key, `Default` for no key."
+          },
+          "enabled": {
+            "$ref": "#/components/schemas/RemitImap.ClassificationValueSource"
+          },
+          "dailyLimit": {
+            "$ref": "#/components/schemas/RemitImap.ClassificationValueSource"
+          }
+        },
+        "description": "Where each classification setting's value comes from."
+      },
       "RemitImap.ClassificationTestFailed": {
         "type": "object",
         "required": [
@@ -9783,15 +9826,15 @@
           },
           "model": {
             "type": "string",
-            "description": "The model to ask for. Empty means the preset's default model."
+            "description": "The model to ask for. Empty means the inherited model."
           },
           "baseUrl": {
             "type": "string",
-            "description": "The http or https base URL to call. Empty means the preset's default base URL."
+            "description": "The http or https base URL to call. Empty means the inherited base URL."
           },
           "apiKey": {
             "type": "string",
-            "description": "The provider's API key. Empty means the key saved for this preset."
+            "description": "The provider's API key. Empty means the key saved for this preset, or the deployment's key when the preset and base URL match the deployment's."
           }
         },
         "description": "The classification provider form as it stands, saved or not."
@@ -9842,6 +9885,37 @@
           }
         ]
       },
+      "RemitImap.ClassificationUnrunnable": {
+        "type": "object",
+        "required": [
+          "state",
+          "presetId",
+          "reason"
+        ],
+        "properties": {
+          "state": {
+            "type": "string",
+            "enum": [
+              "Unrunnable"
+            ]
+          },
+          "presetId": {
+            "$ref": "#/components/schemas/RemitImap.ClassificationPresetId"
+          },
+          "reason": {
+            "$ref": "#/components/schemas/RemitImap.ClassificationUnrunnableReason"
+          }
+        },
+        "description": "A classification provider is chosen but cannot run, so classification is off."
+      },
+      "RemitImap.ClassificationUnrunnableReason": {
+        "type": "string",
+        "enum": [
+          "NoBaseUrl",
+          "NoApiKey"
+        ],
+        "description": "Why a classification provider cannot run."
+      },
       "RemitImap.ClassificationUsage": {
         "type": "object",
         "required": [
@@ -9876,6 +9950,15 @@
         },
         "description": "One mail account's classification calls today."
       },
+      "RemitImap.ClassificationValueSource": {
+        "type": "string",
+        "enum": [
+          "Saved",
+          "Deployment",
+          "Default"
+        ],
+        "description": "Where a classification setting's value comes from."
+      },
       "RemitImap.ConfigDescriptionResponse": {
         "type": "object",
         "required": [
@@ -11806,14 +11889,14 @@
                 "$ref": "#/components/schemas/RemitImap.DisplayNameCorrespondence"
               }
             ],
-            "description": "How the From display name relates to the From domain. Present only for a message the provider's own filter already classified as spam, and only when the sender is not bulk-shaped (no List-Unsubscribe) — absence means the comparison was never made, never that it found nothing."
+            "description": "How the From display name relates to the From domain. Display-only: it never decides placement. Present only when the sender is not bulk-shaped (no List-Unsubscribe) — absence means the comparison was never made, never that it found nothing."
           },
           "offDomainLinkDomains": {
             "type": "array",
             "items": {
               "type": "string"
             },
-            "description": "Registrable domains (eTLD+1) the body's links point at, excluding the From address's own registrable domain. Present only for a message the provider's own filter already classified as spam; an empty array means every link stayed on the sender's domain, absence means the comparison was never made."
+            "description": "Registrable domains (eTLD+1) the body's links point at, excluding the From address's own registrable domain. Display-only: it never decides placement. An empty array means every link stayed on the sender's domain, absence means the comparison was never made."
           },
           "signerDomain": {
             "type": "string",
@@ -14831,29 +14914,29 @@
                 "$ref": "#/components/schemas/RemitImap.ClassificationPresetId"
               }
             ],
-            "description": "Save a classification provider. Saving another preset deletes the stored key. Without it, the classification fields below apply to the saved provider."
+            "description": "Save a classification provider. Saving another preset deletes the stored key, model and base URL. Without it, the classification fields below apply to the provider in effect, saved or inherited from the deployment."
           },
           "classificationModel": {
             "type": "string",
-            "description": "The model to ask for. Empty means the preset's default model."
+            "description": "The model to ask for. Empty deletes the saved model, so it is inherited again."
           },
           "classificationBaseUrl": {
             "type": "string",
-            "description": "The http or https base URL to call. Empty means the preset's default base URL. Refused with 400 `invalid_classification_base_url` when it is not a URL, or when the preset has no default base URL and none is given."
+            "description": "The http or https base URL to call. Empty deletes the saved base URL, so it is inherited again. Refused with 400 `invalid_classification_base_url` when it is not a URL, or when no base URL is saved, inherited or given by the preset."
           },
           "classificationApiKey": {
             "type": "string",
-            "description": "The provider's API key. Write-only: stored encrypted and never returned. Refused with 400 `classification_api_key_required` when the preset needs a key and none is stored for it."
+            "description": "The provider's API key. Write-only: stored encrypted and never returned. Refused with 400 `classification_api_key_required` when the preset needs a key and none is saved, or inherited from the deployment for the same preset and base URL."
           },
           "classificationEnabled": {
             "type": "boolean",
-            "description": "Switch classification on or off. Switching on with no saved provider is refused with 400 `classification_not_configured`; switching off keeps the provider and key."
+            "description": "Switch classification on or off. Switching on with no provider in effect is refused with 400 `classification_not_configured`; switching off keeps the provider and key."
           },
           "classificationDailyLimit": {
             "type": "integer",
             "format": "int32",
             "minimum": 1,
-            "description": "The most classification calls per mail account per UTC day. Needs a saved provider."
+            "description": "The most classification calls per mail account per UTC day. Needs a provider in effect, saved or inherited."
           }
         },
         "description": "A change to the caller's settings. Every field is optional and absence means untouched."
@@ -14891,7 +14974,7 @@
                 "$ref": "#/components/schemas/RemitImap.ClassificationSettings"
               }
             ],
-            "description": "The saved classification provider, or `NotConfigured`."
+            "description": "The classification provider in effect, `Unrunnable` when one is chosen but cannot run, or `NotConfigured`."
           }
         },
         "description": "The caller's own settings: choices that belong to the person rather than to\none mail account. Each field is stored as an `AccountSetting` row of the\naccount config and read back here, so a setting added later is one more\nfield on this resource rather than one more operation."

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/api-openapi-spec",
-  "version": "0.0.89",
+  "version": "0.0.91",
   "description": "Remit API OpenAPI 3 document, generated from TypeSpec, and its precompiled request validators.",
   "exports": {
     ".": "./openapi.json",