mirror of
https://github.com/immich-app/immich.git
synced 2026-05-18 03:10:24 +03:00
document tri-state matrix
This commit is contained in:
Generated
+2
-2
@@ -499,7 +499,7 @@ class AlbumsApi {
|
||||
|
||||
/// List all albums
|
||||
///
|
||||
/// Retrieve a list of albums available to the authenticated user.
|
||||
/// 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) |
|
||||
///
|
||||
/// Note: This method returns the HTTP [Response].
|
||||
///
|
||||
@@ -550,7 +550,7 @@ class AlbumsApi {
|
||||
|
||||
/// List all albums
|
||||
///
|
||||
/// Retrieve a list of albums available to the authenticated user.
|
||||
/// 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) |
|
||||
///
|
||||
/// Parameters:
|
||||
///
|
||||
|
||||
Reference in New Issue
Block a user