DarkSingularity/KeepItGoingServer
Internal
Public Access
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 5 Wiki Activity

Document custom recurrence RRULE patterns and fix stale field names

Browse Source 
API.md now lists the supported custom RRULE patterns (every Wednesday,
every other Wednesday, every second Tuesday, every 15th, etc.) matching
the newly implemented dateutil.rrule evaluation. CLAUDE.md's Task model
reference also gets corrected: it listed recurrence_type/recurrence_interval
fields that never existed on the model.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
Keith Smith
2026-08-31 21:21:50 -06:00
co-authored by Claude Sonnet 5
parent 70dcc1f001
commit a23600a486
3 changed files with 18 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
API.md
+14 -2
View File
@@ -1050,11 +1050,23 @@ Use `page` query parameter to navigate: `?page=2`
- New instance has `status: pending` and calculated `due_date`
- Recurrence stops at `recurrence_end_date` if specified
**Custom RRULE Example:**
**Custom RRULE Patterns:**
`recurrence_rule` accepts a standard RFC5545 RRULE string, evaluated via `dateutil.rrule`. Currently supported: `FREQ=WEEKLY` (with `INTERVAL` and `BYDAY`) and `FREQ=MONTHLY` (with `INTERVAL` and either `BYMONTHDAY` or an ordinal-prefixed `BYDAY`). The web UI's Custom recurrence builder generates these same strings.
| Pattern | `recurrence_rule` |
|---|---|
| Every Wednesday | `FREQ=WEEKLY;INTERVAL=1;BYDAY=WE` |
| Every other Wednesday | `FREQ=WEEKLY;INTERVAL=2;BYDAY=WE` |
| Every Mon/Wed/Fri | `FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR` |
| Every 15th of the month | `FREQ=MONTHLY;INTERVAL=1;BYMONTHDAY=15` |
| Every second Tuesday | `FREQ=MONTHLY;INTERVAL=1;BYDAY=2TU` |
| Last Friday of the month | `FREQ=MONTHLY;INTERVAL=1;BYDAY=-1FR` |
```json
{
"recurrence": "custom",
"recurrence_rule": "FREQ=WEEKLY;BYDAY=MO,WE,FR",
"recurrence_rule": "FREQ=MONTHLY;INTERVAL=1;BYDAY=2TU",
"recurrence_end_date": "2024-12-31"
}
```