Skip to content

High performance self-hosted photo and video management solution.

docs(server): document the UTC timestamp format for timeBucket (#31421)

Alan Grainger7abd625af305
diff --git a/open-api/immich-openapi-specs.json b/open-api/immich-openapi-specs.json
index cb9e32ffde..a8028f6bcd 100644
--- a/open-api/immich-openapi-specs.json
+++ b/open-api/immich-openapi-specs.json
@@ -15946,9 +15946,9 @@
"name": "timeBucket",
"required": true,
"in": "query",
- "description": "Time bucket identifier in YYYY-MM-DD format",
+ "description": "Time bucket identifier in YYYY-MM-DDT00:00:00.000Z format",
"schema": {
- "example": "2024-01-01",
+ "example": "2024-01-01T00:00:00.000Z",
"type": "string"
}
},
diff --git a/server/src/dtos/time-bucket.dto.ts b/server/src/dtos/time-bucket.dto.ts
index a958d62e15..8399d81f46 100644
--- a/server/src/dtos/time-bucket.dto.ts
+++ b/server/src/dtos/time-bucket.dto.ts
@@ -66,7 +66,10 @@ const TimeBucketQueryBaseSchema = z
const TimeBucketSchema = TimeBucketQueryBaseSchema;
const TimeBucketAssetSchema = TimeBucketQueryBaseSchema.extend({
- timeBucket: z.string().describe('Time bucket identifier in YYYY-MM-DD format').meta({ example: '2024-01-01' }),
+ timeBucket: z
+ .string()
+ .describe('Time bucket identifier in YYYY-MM-DDT00:00:00.000Z format')
+ .meta({ example: '2024-01-01T00:00:00.000Z' }),
}).meta({ id: 'TimeBucketAssetDto' });
const stackTupleSchema = z.array(z.string()).length(2).nullable();