helpy4/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich synced 2026-08-15 13:03:57 +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

12
open-api/immich-openapi-specs.json
View file

@ -1424,6 +1424,7 @@
},
"/assets/bulk-upload-check": {
"post": {
"description": "Checks if assets exist by checksums",
"operationId": "checkBulkUpload",
"parameters": [],
"requestBody": {
@ -1459,7 +1460,7 @@
"api_key": []
}
],
"summary": "Checks if assets exist by checksums",
"summary": "checkBulkUpload",
"tags": [
"Assets"
]
@ -1467,6 +1468,7 @@
},
"/assets/device/{deviceId}": {
"get": {
"description": "Get all asset of a device that are in the database, ID only.",
"operationId": "getAllUserAssetsByDeviceId",
"parameters": [
{
@ -1504,7 +1506,7 @@
"api_key": []
}
],
"summary": "Get all asset of a device that are in the database, ID only.",
"summary": "getAllUserAssetsByDeviceId",
"tags": [
"Assets"
]
@ -1512,6 +1514,7 @@
},
"/assets/exist": {
"post": {
"description": "Checks if multiple assets exist on the server and returns all existing - used by background backup",
"operationId": "checkExistingAssets",
"parameters": [],
"requestBody": {
@ -1547,7 +1550,7 @@
"api_key": []
}
],
"summary": "Checks if multiple assets exist on the server and returns all existing - used by background backup",
"summary": "checkExistingAssets",
"tags": [
"Assets"
]
@ -1903,6 +1906,7 @@
]
},
"put": {
"description": "Replace the asset with new file, without changing its id",
"operationId": "replaceAsset",
"parameters": [
{
@ -1956,7 +1960,7 @@
"api_key": []
}
],
"summary": "Replace the asset with new file, without changing its id",
"summary": "replaceAsset",
"tags": [
"Assets"
],

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;