From b84b4284342a3a7706266ac76d9116642b4b5b74 Mon Sep 17 00:00:00 2001 From: Ralph Slooten Date: Sun, 25 May 2025 09:56:53 +1200 Subject: [PATCH] Chore: Add note to swagger docs about API date formats --- internal/storage/structs.go | 5 +++-- server/ui/api/v1/swagger.json | 4 ++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/internal/storage/structs.go b/internal/storage/structs.go index 51068b2..edde6fa 100644 --- a/internal/storage/structs.go +++ b/internal/storage/structs.go @@ -29,7 +29,8 @@ type Message struct { Subject string // List-Unsubscribe header information ListUnsubscribe ListUnsubscribe - // Message date if set, else date received + // Message RFC3339Nano date & time (if set), else date & time received + // ([extended RFC3339](https://tools.ietf.org/html/rfc3339#section-5.6) format with optional nano seconds) Date time.Time // Message tags Tags []string @@ -83,7 +84,7 @@ type MessageSummary struct { ReplyTo []*mail.Address // Email subject Subject string - // Created time + // Received RFC3339Nano date & time ([extended RFC3339](https://tools.ietf.org/html/rfc3339#section-5.6) format with optional nano seconds) Created time.Time // Message tags Tags []string diff --git a/server/ui/api/v1/swagger.json b/server/ui/api/v1/swagger.json index 2e4de7e..f033dd1 100644 --- a/server/ui/api/v1/swagger.json +++ b/server/ui/api/v1/swagger.json @@ -1488,7 +1488,7 @@ } }, "Date": { - "description": "Message date if set, else date received", + "description": "Message RFC3339Nano date \u0026 time (if set), else date \u0026 time received\n([extended RFC3339](https://tools.ietf.org/html/rfc3339#section-5.6) format with optional nano seconds)", "type": "string", "format": "date-time" }, @@ -1594,7 +1594,7 @@ } }, "Created": { - "description": "Created time", + "description": "Received RFC3339Nano date \u0026 time ([extended RFC3339](https://tools.ietf.org/html/rfc3339#section-5.6) format with optional nano seconds)", "type": "string", "format": "date-time" },