github-mirrors/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2026-05-18 03:10:24 +03:00
Code Issues Packages Projects Releases Wiki Activity

document tri-state matrix

Browse Source
This commit is contained in:
timonrieger
2026-05-03 16:27:12 +02:00
parent 7d8be12330
commit a5b2355d0c
3 changed files with 19 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
server/src/controllers/album.controller.ts
+16 -1
View File
@@ -29,7 +29,22 @@ export class AlbumController {
@Authenticated({ permission: Permission.AlbumRead })
@Endpoint({
summary: 'List all albums',
description: 'Retrieve a list of albums available to the authenticated user.',
description: [
'Retrieve a list of albums available to the authenticated user.',
'Results are filtered by the `owned` and `shared` query parameters:',
'',
'| `owned` | `shared` | Result |',
'|---------|----------|--------|',
'| — | — | All accessible albums (owned + shared-with-me) |',
'| `true` | — | Only albums owned by the user |',
'| `false` | — | Only albums shared with the user (not owned) |',
'| `true` | `true` | Owned albums that have been shared out |',
'| `true` | `false` | Owned private albums (not shared) |',
'| — | `true` | Owned albums shared out, plus all albums shared with the user |',
'| — | `false` | Owned private albums only (albums shared with the user are always excluded because the user is a non-owner member) |',
'| `false` | `true` | Albums shared with the user (same as `owned=false`) |',
'| `false` | `false` | Empty (logically impossible combination) |',
].join('\n'),
history: new HistoryBuilder().added('v1').beta('v1').stable('v2'),
})
getAllAlbums(@Auth() auth: AuthDto, @Query() query: GetAlbumsDto): Promise<AlbumResponseDto[]> {