@remit/api-openapi-spec 0.0.66 → 0.0.68

package/openapi.json

@@ -2297,6 +2297,15 @@
                 "$ref": "#/components/schemas/UUID"
               }
             }
+          },
+          {
+            "name": "calendarObjectId",
+            "in": "query",
+            "required": false,
+            "description": "Restrict to the occurrences of this one resource, read from it alone rather than from its collection. A resource none of the listed collections holds lists nothing.",
+            "schema": {
+              "$ref": "#/components/schemas/UUID"
+            }
           }
         ],
         "responses": {
@@ -2352,7 +2361,7 @@
       },
       "post": {
         "operationId": "CalendarEventOperations_createCalendarEvent",
-        "description": "Create an event. The server builds the VEVENT and writes it through the single calendar write path — the same one an accepted invitation and a later CalDAV PUT go through — so the object, its expanded occurrences and the collection's sync sequence land together or not at all.",
+        "description": "Create an event. The server builds the VEVENT and writes it through the single calendar write path — the same one an accepted invitation and a later CalDAV PUT go through — so the object, its expanded occurrences and the collection's sync sequence land together or not at all. Refused with 400 `read_only_calendar` for a `Subscribed` collection, whose events belong to the feed.",
         "parameters": [],
         "responses": {
           "200": {
@@ -2432,8 +2441,8 @@
           {
             "name": "calendarId",
             "in": "query",
-            "required": true,
-            "description": "Collection the resource lives in. A resource is addressed by its collection and its own id, which is what a client holds: every occurrence a listing returns carries both.",
+            "required": false,
+            "description": "Collection the resource lives in. A resource is addressed by its collection and its own id, which is what a client holds: every occurrence a listing returns carries both. Omitted, the resource is looked for in every collection the caller holds.",
             "schema": {
               "$ref": "#/components/schemas/UUID"
             }
@@ -2611,7 +2620,7 @@
       },
       "delete": {
         "operationId": "CalendarEventDetailOperations_deleteCalendarEvent",
-        "description": "Delete an event. `All` removes the resource and every occurrence it\nproduced; `This` writes an EXDATE for the named occurrence and keeps the\nrest of the series; `Following` truncates the series to end just before\nit.\n\nSame refusals and the same `If-Match` precondition as the update.",
+        "description": "Delete an event. `All` removes the resource and every occurrence it\nproduced; `This` writes an EXDATE for the named occurrence and keeps the\nrest of the series; `Following` truncates the series to end just before\nit.\n\nSame refusals and the same `If-Match` precondition as the update.\nAn event in a `Subscribed` collection is refused with 400\n`read_only_calendar`, here and on the update.",
         "parameters": [
           {
             "name": "calendarObjectId",
@@ -3117,7 +3126,7 @@
       },
       "post": {
         "operationId": "CalendarOperations_createCalendar",
-        "description": "Create a calendar collection. Refused with 400 when `urlSegment` is empty or already taken in this account config — the segment is the collection's identity, so a second create under the same one would otherwise silently return the collection that already exists.",
+        "description": "Create a calendar collection. Refused with 400 when `urlSegment` is empty or already taken in this account config — the segment is the collection's identity, so a second create under the same one would otherwise silently return the collection that already exists. With `subscriptionUrl` the feed is fetched first and a fetch that fails is refused with 400 `subscription_unreachable`, naming why and never the URL.",
         "parameters": [],
         "responses": {
           "200": {
@@ -3227,6 +3236,7 @@
       },
       "patch": {
         "operationId": "CalendarDetailOperations_updateCalendar",
+        "description": "Update a calendar collection. `subscriptionEnabled` is refused with 400 `not_subscribed` on a collection that is not `Subscribed`. Turning it off stops the refresh and removes nothing.",
         "parameters": [
           {
             "name": "calendarId",
@@ -7684,6 +7694,11 @@
           "source",
           "timezone",
           "syncSequence",
+          "subscriptionUrl",
+          "subscriptionEnabled",
+          "subscriptionCheckedAt",
+          "subscriptionFetchedAt",
+          "subscriptionError",
           "createdAt",
           "updatedAt"
         ],
@@ -7768,6 +7783,45 @@
             "default": 0,
             "readOnly": true
           },
+          "subscriptionUrl": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/String2048"
+              }
+            ],
+            "description": "The read-only iCalendar URL a `Subscribed` collection is filled from, such as a Google Calendar secret address. For some providers the URL is the whole credential, so it never reaches a log line. `\"\"` for every other source.",
+            "default": "",
+            "readOnly": true
+          },
+          "subscriptionEnabled": {
+            "type": "boolean",
+            "description": "Whether the scheduled refresh re-reads `subscriptionUrl`. Turning it off stops the refresh and keeps every stored event. Always `false` on a collection that is not `Subscribed`.",
+            "default": false
+          },
+          "subscriptionCheckedAt": {
+            "type": "integer",
+            "format": "int64",
+            "description": "When the subscription was last fetched, whatever the outcome. `0` when it never was.",
+            "default": 0,
+            "readOnly": true
+          },
+          "subscriptionFetchedAt": {
+            "type": "integer",
+            "format": "int64",
+            "description": "When the subscription was last fetched and written. `0` when it never was.",
+            "default": 0,
+            "readOnly": true
+          },
+          "subscriptionError": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/String512"
+              }
+            ],
+            "description": "Why the last fetch failed, or which events in it could not be stored. `\"\"` when the last fetch landed whole.",
+            "default": "",
+            "readOnly": true
+          },
           "createdAt": {
             "type": "integer",
             "format": "int64",
@@ -7786,9 +7840,10 @@
         "enum": [
           "Default",
           "UserCreated",
-          "MailDerived"
+          "MailDerived",
+          "Subscribed"
         ],
-        "description": "Where a calendar collection came from. `Default` is the one provisioned per account config on first use and is never deleted; `UserCreated` is one a person made; `MailDerived` is one populated from mail rather than by a person."
+        "description": "Where a calendar collection came from. `Default` is the one provisioned per account config on first use and is never deleted; `UserCreated` is one a person made; `MailDerived` is one populated from mail rather than by a person; `Subscribed` is filled from a read-only iCalendar URL and refuses every write except its own refresh."
       },
       "RemitImap.CalendarSuggestionResponse": {
         "type": "object",
@@ -8496,6 +8551,14 @@
               }
             ],
             "description": "IANA time zone this collection's floating times are read in. Absent reads them as UTC."
+          },
+          "subscriptionUrl": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/String2048"
+              }
+            ],
+            "description": "A read-only iCalendar URL to subscribe the collection to. `http`, `https` and `webcal` are accepted. The server fetches it once before creating anything and refuses with 400 when the fetch fails, so a mistyped address leaves no empty calendar behind. The collection is then `Subscribed`: it refuses event writes, and the scheduled refresh keeps it in step with the feed."
           }
         },
         "description": "Input for creating a calendar collection (issue #15).\n\n`urlSegment` is supplied rather than derived from the display name: it is the\ncollection's identity — `calendarId` is a hash of it — and the path a CalDAV\nclient will later bookmark. Slugging a name would make two calendars called\n\"Work\" one row, and a rename would either move a bookmarked path or leave a\nsegment that no longer matches anything a person recognises. The name is the\nmutable overlay; this is the address."
@@ -12150,9 +12213,14 @@
             ],
             "description": "IANA time zone this collection's floating times are read in, e.g. \"Europe/Amsterdam\". `\"\"` when none is set, which reads as UTC.",
             "default": ""
+          },
+          "subscriptionEnabled": {
+            "type": "boolean",
+            "description": "Whether the scheduled refresh re-reads `subscriptionUrl`. Turning it off stops the refresh and keeps every stored event. Always `false` on a collection that is not `Subscribed`.",
+            "default": false
           }
         },
-        "description": "Input for updating a calendar collection. The name, colour and timezone are the mutable overlay; `urlSegment` is not among them, because it is the collection's identity and the path a client has bookmarked."
+        "description": "Input for updating a calendar collection. The name, colour and timezone are the mutable overlay, and `subscriptionEnabled` turns a subscribed collection's refresh off and on. `urlSegment` is not among them, because it is the collection's identity and the path a client has bookmarked."
       },
       "RemitImap.UpdateFilterInput": {
         "type": "object",

package/package.json

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