Skip to content

High performance self-hosted photo and video management solution.

fix: album dto docs (#25873)

Jason Rasmussen3ea65f8d27e6
diff --git a/mobile/openapi/lib/api/albums_api.dart b/mobile/openapi/lib/api/albums_api.dart
index 713bcafee3..e2db95b9e0 100644
--- a/mobile/openapi/lib/api/albums_api.dart
+++ b/mobile/openapi/lib/api/albums_api.dart
@@ -473,7 +473,7 @@ class AlbumsApi {
/// Filter albums containing this asset ID (ignores shared parameter)
///
/// * [bool] shared:
- /// Filter by shared status: true = only shared, false = only own, undefined = all
+ /// Filter by shared status: true = only shared, false = not shared, undefined = all owned albums
Future<Response> getAllAlbumsWithHttpInfo({ String? assetId, bool? shared, }) async {
// ignore: prefer_const_declarations
final apiPath = r'/albums';
@@ -516,7 +516,7 @@ class AlbumsApi {
/// Filter albums containing this asset ID (ignores shared parameter)
///
/// * [bool] shared:
- /// Filter by shared status: true = only shared, false = only own, undefined = all
+ /// Filter by shared status: true = only shared, false = not shared, undefined = all owned albums
Future<List<AlbumResponseDto>?> getAllAlbums({ String? assetId, bool? shared, }) async {
final response = await getAllAlbumsWithHttpInfo( assetId: assetId, shared: shared, );
if (response.statusCode >= HttpStatus.badRequest) {
diff --git a/open-api/immich-openapi-specs.json b/open-api/immich-openapi-specs.json
index c2701ff42b..498de43471 100644
--- a/open-api/immich-openapi-specs.json
+++ b/open-api/immich-openapi-specs.json
@@ -1618,7 +1618,7 @@
"name": "shared",
"required": false,
"in": "query",
- "description": "Filter by shared status: true = only shared, false = only own, undefined = all",
+ "description": "Filter by shared status: true = only shared, false = not shared, undefined = all owned albums",
"schema": {
"type": "boolean"
}
diff --git a/server/src/dtos/album.dto.ts b/server/src/dtos/album.dto.ts
index 0f46ebaa42..62013fbd92 100644
--- a/server/src/dtos/album.dto.ts
+++ b/server/src/dtos/album.dto.ts
@@ -102,7 +102,7 @@ export class UpdateAlbumDto {
export class GetAlbumsDto {
@ValidateBoolean({
optional: true,
- description: 'Filter by shared status: true = only shared, false = only own, undefined = all',
+ description: 'Filter by shared status: true = only shared, false = not shared, undefined = all owned albums',
})
shared?: boolean;