hulthe/immich-sdk
1
0
Fork 0
Code Issues 1 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Update SDK for Immich v3 Breaking Changes #4

New Issue
Open
opened 2026-06-18 16:33:37 +02:00 by hulthe · 0 comments
hulthe commented 2026-06-18 16:33:37 +02:00
Owner
Copy Link
Copy Source

The Immich v3.0.0-rc.1 release introduces several breaking changes to the API that require updates in this SDK.

Endpoints to Remove

  • GET /server/theme: Removed.
  • PUT /albums/assets: Removed (assets are now automatically added to shared links upon upload).
  • PUT /albums/{id}/assets: Removed (assets are now automatically added to shared links upon upload).
  • PUT /assets/{id}/original: Removed (replaces replaceAsset).
  • GET /assets/random: Removed.
  • POST /assets/exists: Removed.
  • GET /assets/device/{deviceId}: Removed.
  • POST /sync/delta-sync: Removed.
  • POST /sync/full-sync: Removed.

Endpoints to Refactor

  • GET /albums: Rename shared parameter to isShared and add isOwned (boolean) parameter.
  • POST /shared-links: Move password from query parameter to request body.
  • POST /assets: Remove deviceId and deviceAssetId from AssetMediaCreateDto.

DTO and Schema Updates

  • AssetResponseDto:
    • Remove deviceId, deviceAssetId, and unassignedFaces.
    • Update duration to be a nullable number (milliseconds).
    • Update width and height to be integers.
  • AlbumResponseDto: Remove owner, ownerId, and assets.
  • ExifResponseDto: Update exifImageWidth, exifImageHeight, iso, and rating to be integers.
  • *SearchDto: Update page, size, and rating to be integers.
  • Error Responses: Update response structure to use an errors array and move statusCode and correlationId to the X-Correlation-ID header.
The Immich v3.0.0-rc.1 release introduces several breaking changes to the API that require updates in this SDK. ## Endpoints to Remove - `GET /server/theme`: Removed. - `PUT /albums/assets`: Removed (assets are now automatically added to shared links upon upload). - `PUT /albums/{id}/assets`: Removed (assets are now automatically added to shared links upon upload). - `PUT /assets/{id}/original`: Removed (replaces `replaceAsset`). - `GET /assets/random`: Removed. - `POST /assets/exists`: Removed. - `GET /assets/device/{deviceId}`: Removed. - `POST /sync/delta-sync`: Removed. - `POST /sync/full-sync`: Removed. ## Endpoints to Refactor - `GET /albums`: Rename `shared` parameter to `isShared` and add `isOwned` (boolean) parameter. - `POST /shared-links`: Move `password` from query parameter to request body. - `POST /assets`: Remove `deviceId` and `deviceAssetId` from `AssetMediaCreateDto`. ## DTO and Schema Updates - **`AssetResponseDto`**: - Remove `deviceId`, `deviceAssetId`, and `unassignedFaces`. - Update `duration` to be a nullable number (milliseconds). - Update `width` and `height` to be integers. - **`AlbumResponseDto`**: Remove `owner`, `ownerId`, and `assets`. - **`ExifResponseDto`**: Update `exifImageWidth`, `exifImageHeight`, `iso`, and `rating` to be integers. - **`*SearchDto`**: Update `page`, `size`, and `rating` to be integers. - **Error Responses**: Update response structure to use an `errors` array and move `statusCode` and `correlationId` to the `X-Correlation-ID` header.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
No items
No labels
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
marvin (Marvin) hulthe (Joakim Hulthe)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: hulthe/immich-sdk#4