helpy4/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich synced 2025-10-17 18:19:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix(docs): move a few API doc comments to descriptions (#15381)

Browse source 
Previously, the comments were being used as the summaries, and thus were
displayed as the “title” of these endpoints
This commit is contained in:
Ben Cochran 2025-01-29 08:58:10 -08:00 • committed by GitHub
parent a0aea021a1
commit b4a4abbf51
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 50 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

8
open-api/typescript-sdk/src/fetch-client.ts
View file

@ -1703,7 +1703,7 @@ export function updateAssets({ assetBulkUpdateDto }: {
})));
}
/**
* Checks if assets exist by checksums
* checkBulkUpload
*/
export function checkBulkUpload({ assetBulkUploadCheckDto }: {
assetBulkUploadCheckDto: AssetBulkUploadCheckDto;
@ -1718,7 +1718,7 @@ export function checkBulkUpload({ assetBulkUploadCheckDto }: {
})));
}
/**
* Get all asset of a device that are in the database, ID only.
* getAllUserAssetsByDeviceId
*/
export function getAllUserAssetsByDeviceId({ deviceId }: {
deviceId: string;
@ -1731,7 +1731,7 @@ export function getAllUserAssetsByDeviceId({ deviceId }: {
}));
}
/**
* Checks if multiple assets exist on the server and returns all existing - used by background backup
* checkExistingAssets
*/
export function checkExistingAssets({ checkExistingAssetsDto }: {
checkExistingAssetsDto: CheckExistingAssetsDto;
@ -1839,7 +1839,7 @@ export function downloadAsset({ id, key }: {
}));
}
/**
* Replace the asset with new file, without changing its id
* replaceAsset
*/
export function replaceAsset({ id, key, assetMediaReplaceDto }: {
id: string;