From c980f5fc1999b5cf9e6fc85e49a8aed44fbe3b1e Mon Sep 17 00:00:00 2001 From: Yaros Date: Thu, 26 Mar 2026 11:50:29 +0100 Subject: [PATCH] chore(docs): withPeople parameter description (#27262) * fix(server): withPeople inconsistent * fix: query failing in some occasions * test: add medium tests for withPeople option * Revert "test: add medium tests for withPeople option" This reverts commit 6c1505ba6b4771e37c1679bb96866a642134223d. * Revert "fix: query failing in some occasions" This reverts commit 221feeca45ae58fbac9e1b604202e6e0dedd4044. * Revert "fix(server): withPeople inconsistent" This reverts commit 4289a9f23d48248f0779cd2efff91875cfe98b52. * chore: change endpoint description * chore: generate open-api --- mobile/openapi/lib/model/metadata_search_dto.dart | 2 +- mobile/openapi/lib/model/random_search_dto.dart | 2 +- open-api/immich-openapi-specs.json | 4 ++-- open-api/typescript-sdk/src/fetch-client.ts | 4 ++-- server/src/dtos/search.dto.ts | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/mobile/openapi/lib/model/metadata_search_dto.dart b/mobile/openapi/lib/model/metadata_search_dto.dart index 81f8d41527..4dbc90d407 100644 --- a/mobile/openapi/lib/model/metadata_search_dto.dart +++ b/mobile/openapi/lib/model/metadata_search_dto.dart @@ -379,7 +379,7 @@ class MetadataSearchDto { /// bool? withExif; - /// Include assets with people + /// Include people data in response /// /// Please note: This property should have been non-nullable! Since the specification file /// does not include a default value (using the "default:" property), however, the generated diff --git a/mobile/openapi/lib/model/random_search_dto.dart b/mobile/openapi/lib/model/random_search_dto.dart index 4166fc9f3c..d5803c9cc7 100644 --- a/mobile/openapi/lib/model/random_search_dto.dart +++ b/mobile/openapi/lib/model/random_search_dto.dart @@ -273,7 +273,7 @@ class RandomSearchDto { /// bool? withExif; - /// Include assets with people + /// Include people data in response /// /// Please note: This property should have been non-nullable! Since the specification file /// does not include a default value (using the "default:" property), however, the generated diff --git a/open-api/immich-openapi-specs.json b/open-api/immich-openapi-specs.json index a504214681..e5e888c2f8 100644 --- a/open-api/immich-openapi-specs.json +++ b/open-api/immich-openapi-specs.json @@ -19129,7 +19129,7 @@ "type": "boolean" }, "withPeople": { - "description": "Include assets with people", + "description": "Include people data in response", "type": "boolean" }, "withStacked": { @@ -20868,7 +20868,7 @@ "type": "boolean" }, "withPeople": { - "description": "Include assets with people", + "description": "Include people data in response", "type": "boolean" }, "withStacked": { diff --git a/open-api/typescript-sdk/src/fetch-client.ts b/open-api/typescript-sdk/src/fetch-client.ts index aa71f9f896..d7375a5f83 100644 --- a/open-api/typescript-sdk/src/fetch-client.ts +++ b/open-api/typescript-sdk/src/fetch-client.ts @@ -1741,7 +1741,7 @@ export type MetadataSearchDto = { withDeleted?: boolean; /** Include EXIF data in response */ withExif?: boolean; - /** Include assets with people */ + /** Include people data in response */ withPeople?: boolean; /** Include stacked assets */ withStacked?: boolean; @@ -1855,7 +1855,7 @@ export type RandomSearchDto = { withDeleted?: boolean; /** Include EXIF data in response */ withExif?: boolean; - /** Include assets with people */ + /** Include people data in response */ withPeople?: boolean; /** Include stacked assets */ withStacked?: boolean; diff --git a/server/src/dtos/search.dto.ts b/server/src/dtos/search.dto.ts index f72ecdf8b6..196e72c37e 100644 --- a/server/src/dtos/search.dto.ts +++ b/server/src/dtos/search.dto.ts @@ -146,7 +146,7 @@ export class RandomSearchDto extends BaseSearchWithResultsDto { @ValidateBoolean({ optional: true, description: 'Include stacked assets' }) withStacked?: boolean; - @ValidateBoolean({ optional: true, description: 'Include assets with people' }) + @ValidateBoolean({ optional: true, description: 'Include people data in response' }) withPeople?: boolean; }