From f1eb009c252a19b5bf1c961a8457936150f5acb4 Mon Sep 17 00:00:00 2001 From: Jeremy <161660+jamarzka@users.noreply.github.com> Date: Mon, 6 Oct 2025 10:24:48 -0500 Subject: [PATCH] Fix the orderBy validation description --- mobile/openapi/lib/api/timeline_api.dart | 8 ++++---- open-api/immich-openapi-specs.json | 4 ++-- server/src/dtos/time-bucket.dto.ts | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/mobile/openapi/lib/api/timeline_api.dart b/mobile/openapi/lib/api/timeline_api.dart index 8f6bf4ec85..ed3e719821 100644 --- a/mobile/openapi/lib/api/timeline_api.dart +++ b/mobile/openapi/lib/api/timeline_api.dart @@ -40,7 +40,7 @@ class TimelineApi { /// Sort order for assets within time buckets (ASC for oldest first, DESC for newest first) /// /// * [AssetOrderBy] orderBy: - /// Sort order by for assets within time buckets (DATE_TAKEN, DATE_ADDED, DATE_DELETED) + /// The field to sort time bucket assets by (DATE_TAKEN, DATE_ADDED, DATE_DELETED) /// /// * [String] personId: /// Filter assets containing a specific person (face recognition) @@ -155,7 +155,7 @@ class TimelineApi { /// Sort order for assets within time buckets (ASC for oldest first, DESC for newest first) /// /// * [AssetOrderBy] orderBy: - /// Sort order by for assets within time buckets (DATE_TAKEN, DATE_ADDED, DATE_DELETED) + /// The field to sort time bucket assets by (DATE_TAKEN, DATE_ADDED, DATE_DELETED) /// /// * [String] personId: /// Filter assets containing a specific person (face recognition) @@ -215,7 +215,7 @@ class TimelineApi { /// Sort order for assets within time buckets (ASC for oldest first, DESC for newest first) /// /// * [AssetOrderBy] orderBy: - /// Sort order by for assets within time buckets (DATE_TAKEN, DATE_ADDED, DATE_DELETED) + /// The field to sort time bucket assets by (DATE_TAKEN, DATE_ADDED, DATE_DELETED) /// /// * [String] personId: /// Filter assets containing a specific person (face recognition) @@ -326,7 +326,7 @@ class TimelineApi { /// Sort order for assets within time buckets (ASC for oldest first, DESC for newest first) /// /// * [AssetOrderBy] orderBy: - /// Sort order by for assets within time buckets (DATE_TAKEN, DATE_ADDED, DATE_DELETED) + /// The field to sort time bucket assets by (DATE_TAKEN, DATE_ADDED, DATE_DELETED) /// /// * [String] personId: /// Filter assets containing a specific person (face recognition) diff --git a/open-api/immich-openapi-specs.json b/open-api/immich-openapi-specs.json index 1efff570f6..cd32b38d51 100644 --- a/open-api/immich-openapi-specs.json +++ b/open-api/immich-openapi-specs.json @@ -8845,7 +8845,7 @@ "name": "orderBy", "required": false, "in": "query", - "description": "Sort order by for assets within time buckets (DATE_TAKEN, DATE_ADDED, DATE_DELETED)", + "description": "The field to sort time bucket assets by (DATE_TAKEN, DATE_ADDED, DATE_DELETED)", "schema": { "$ref": "#/components/schemas/AssetOrderBy" } @@ -9018,7 +9018,7 @@ "name": "orderBy", "required": false, "in": "query", - "description": "Sort order by for assets within time buckets (DATE_TAKEN, DATE_ADDED, DATE_DELETED)", + "description": "The field to sort time bucket assets by (DATE_TAKEN, DATE_ADDED, DATE_DELETED)", "schema": { "$ref": "#/components/schemas/AssetOrderBy" } diff --git a/server/src/dtos/time-bucket.dto.ts b/server/src/dtos/time-bucket.dto.ts index cd4c116ddc..38c27143e6 100644 --- a/server/src/dtos/time-bucket.dto.ts +++ b/server/src/dtos/time-bucket.dto.ts @@ -49,7 +49,7 @@ export class TimeBucketDto { @ValidateEnum({ enum: AssetOrderBy, name: 'AssetOrderBy', - description: 'Sort order by for assets within time buckets (DATE_TAKEN, DATE_ADDED, DATE_DELETED)', + description: 'The field to sort time bucket assets by (DATE_TAKEN, DATE_ADDED, DATE_DELETED)', optional: true, }) orderBy?: AssetOrderBy;