Docs: the morning digest in the API reference (#171)

POST /diffinery/emails/digest (#168) gets its summary, limit and scope,
and the notification settings entry names the digest's fields.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_016q5wwBFck8JHq14gHUM2CL

Canberk Demirci authored 12 days ago· GitHub committed 12 days agosigned1 parent 7041870commit 5faec44bed4d4a0979b56272409dd0c66ff73e09Browse files

1 file changed+3−1

modifiedapps/diffinery/src/docs/api-meta.ts+3−1View file

		@@ -104,6 +104,7 @@
104	104	"PUT /notifications": { scope: "write" },
105	105	"PUT /diffinery/notification-settings": { scope: "write" },
106	106	"POST /diffinery/emails/test": { scope: "write" },
	107	+ "POST /diffinery/emails/digest": { scope: "write" },
107	108	"POST /diffinery/admin/emails/samples": { scope: "admin" },
108	109	"POST /diffinery/email/verification": { scope: "write" },
109	110	"GET /diffinery/admin/email/suppressions": { scope: "read" },
		@@ -1547,13 +1548,14 @@
1547	1548	},
1548	1549	"DELETE /repos/{owner}/{repo}/subscription": { summary: "Stop watching a repository", description: "Back to participating notifications.", access: "read", status: 204 },
1549	1550	"GET /diffinery/notification-settings": { summary: "Get your notification settings", access: "account" },
1550		- "PUT /diffinery/notification-settings": { summary: "Update your notification settings", description: "Send only the groups you want to change.", access: "account" },
	1551	+ "PUT /diffinery/notification-settings": { summary: "Update your notification settings", description: "Send only the groups you want to change. The morning digest is `digest`: `email` (on or off), `hour` (0 to 23), `timeZone` (an IANA time zone such as `Europe/Istanbul` or `UTC`) and `weekends`; 422 for an hour or time zone it can't use. See /docs/agents/today#the-morning-digest.", access: "account" },
1551	1552	"GET /diffinery/emails": {
1552	1553	summary: "List emails sent to you",
1553	1554	access: "account",
1554	1555	query: { kind: ["string", "Only this kind of email."], since: ["string", "ISO timestamp."], per_page: ["integer", "At most this many (default 50)."], all: ["string", "`1` for everyone's (site admins)."] },
1555	1556	},
1556	1557	"POST /diffinery/emails/test": { summary: "Send yourself a test email", description: "At most 5 an hour; more answer 429 `you can send at most 5 test emails an hour; try again later`.", access: "account" },
	1558	+ "POST /diffinery/emails/digest": { summary: "Send yourself the morning digest now", description: "Your Today digest, sent now even when the digest is off or has nothing in it, covering what happened since the last one. At most 3 an hour; more answer 429. See /docs/agents/today#the-morning-digest.", access: "account" },
1557	1559	"GET /diffinery/email": {
1558	1560	summary: "Your email address and whether it is suppressed",
1559	1561	description: "`suppressed` is null, or why Diffinery sends nothing to your address: `reason` (`hard-bounce`, `complaint` or `manual`), `detail`, `source`, `created_at` and `owner_can_lift`.",

codician/diffinerypublic

Docs: the morning digest in the API reference (#171)