Update event & relevant request schemas to support recurring events (#579)

* Update event & relevant request schemas to support recurring events

* Update CalendarEventRecurrence.yaml

* Update UpdateCalendarEventRequest.yaml

* Update CalendarEventRecurrence.yaml

Author: VinyarionHyarmendacil

openapi/components/requests/CreateCalendarEventRequest.yaml

@@ -33,12 +33,16 @@ properties:
       $ref: ../schemas/LanguageCode.yaml
     maxItems: 3
     minItems: 0
+  occurrenceKind:
+    $ref: ../schemas/CalendarEventOccurrenceKind.yaml
   parentId:
     $ref: ../schemas/CalendarID.yaml
   platforms:
     type: array
     items:
       $ref: ../schemas/CalendarEventPlatform.yaml
+  recurrence:
+    $ref: ../schemas/CalendarEventRecurrence.yaml
   roleIds:
     type: array
     items:

openapi/components/requests/UpdateCalendarEventRequest.yaml

@@ -36,6 +36,8 @@ properties:
     type: array
     items:
       type: string
+  recurrence:
+    $ref: ../schemas/CalendarEventRecurrence.yaml
   roleIds:
     type: array
     items:

openapi/components/schemas/CalendarDayOfWeek.yaml

@@ -0,0 +1,13 @@
+title: CalendarDayOfWeek
+type: string
+description: The day of the week, used for recurring events.
+enum:
+  - FR
+  - MO
+  - SA
+  - SU
+  - TH
+  - TU
+  - WE
+default: SU
+example: FR

openapi/components/schemas/CalendarEvent.yaml

@@ -47,18 +47,15 @@ properties:
     items:
       $ref: ./LanguageCode.yaml
   occurrenceKind:
-    type: string
-    description: So far if it exists, always the string "single"
+    $ref: ./CalendarEventOccurrenceKind.yaml
   ownerId:
     $ref: ./GroupID.yaml
   platforms:
     type: array
     items:
       $ref: ./CalendarEventPlatform.yaml
   recurrence:
-    type: string
-    description: So far unused, always "null"
-    nullable: true
+    $ref: ./CalendarEventRecurrence.yaml
   roleIds:
     type: array
     description: Group roles that may join this event

openapi/components/schemas/CalendarEventFrequency.yaml

@@ -0,0 +1,10 @@
+title: CalendarEventFrequency
+type: string
+description: The time unit used to specify how often a recurring event occurs.
+enum:
+  - daily
+  - monthly
+  - weekly
+  - yearly
+default: weekly
+example: weekly

openapi/components/schemas/CalendarEventOccurrenceKind.yaml

@@ -0,0 +1,9 @@
+title: CalendarEventOccurrenceKind
+type: string
+description: How an event occurs or recurs. "single" is a standalone event, "series" is a parent specification of a recurring series, and "occurrence" is an individual event in a series.
+enum:
+  - occurrence
+  - series
+  - single
+default: single
+example: single

openapi/components/schemas/CalendarEventRecurrence.yaml

@@ -0,0 +1,26 @@
+title: CalendarEventRecurrence
+type: object
+description: Details about how a recurring event will be scheduled. If the event is to be scheduled indefinitely, this will lack an "end" property.
+nullable: true
+properties:
+  daysOfWeek:
+    type: array
+    description: Which days of the week the event will be scheduled, only valid/present for "weekly" recurring events
+    items:
+      $ref: ./CalendarDayOfWeek.yaml
+  end:
+    $ref: ./CalendarEventRecurrenceEnd.yaml
+  frequency:
+    $ref: ./CalendarEventFrequency.yaml
+  interval:
+    type: integer
+    description: How often the event will be scheduled, in units of "frequency"
+    minimum: 1
+  timezone:
+    type: string
+    description: The timezone the event will be scheduled in, in Area/Location format
+    example: America/Chicago
+required:
+  - frequency
+  - interval
+  - timezone

openapi/components/schemas/CalendarEventRecurrenceEnd.yaml

@@ -0,0 +1,16 @@
+title: CalendarEventRecurrenceEnd
+type: object
+description: Details about how a recurring event stops being scheduled
+properties:
+  count:
+    type: integer
+    description: Required for "afterOccurrences" - The number of times the event will be scheduled before it stops being scheduled
+    minimum: 1
+  date:
+    type: string
+    description: Required for "afterDate" - The date and time after which the event will stop being scheduled, **without timezone or offset**
+    example: 2026-12-31T23:59:00
+  type:
+    $ref: ./CalendarEventRecurrenceEndType.yaml
+required:
+  - type

openapi/components/schemas/CalendarEventRecurrenceEndType.yaml

@@ -0,0 +1,8 @@
+title: CalendarEventRecurrenceEndTyoe
+type: string
+description: How a recurring event stops being scheduled
+enum:
+  - afterDate
+  - afterOccurrences
+default: afterDate
+example: afterOccurrences