immich-app/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2025-12-17 01:11:13 +03:00
Code Issues Packages Projects Releases 16 Wiki Activity

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
6 changed files with 50 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
mobile/openapi/README.md generated
View File

@@ -93,17 +93,17 @@ Class | Method | HTTP request | Description
*AlbumsApi* | [**removeUserFromAlbum**](doc//AlbumsApi.md#removeuserfromalbum) | **DELETE** /albums/{id}/user/{userId} |
*AlbumsApi* | [**updateAlbumInfo**](doc//AlbumsApi.md#updatealbuminfo) | **PATCH** /albums/{id} |
*AlbumsApi* | [**updateAlbumUser**](doc//AlbumsApi.md#updatealbumuser) | **PUT** /albums/{id}/user/{userId} |
*AssetsApi* | [**checkBulkUpload**](doc//AssetsApi.md#checkbulkupload) | **POST** /assets/bulk-upload-check | Checks if assets exist by checksums
*AssetsApi* | [**checkExistingAssets**](doc//AssetsApi.md#checkexistingassets) | **POST** /assets/exist | Checks if multiple assets exist on the server and returns all existing - used by background backup
*AssetsApi* | [**checkBulkUpload**](doc//AssetsApi.md#checkbulkupload) | **POST** /assets/bulk-upload-check | checkBulkUpload
*AssetsApi* | [**checkExistingAssets**](doc//AssetsApi.md#checkexistingassets) | **POST** /assets/exist | checkExistingAssets
*AssetsApi* | [**deleteAssets**](doc//AssetsApi.md#deleteassets) | **DELETE** /assets |
*AssetsApi* | [**downloadAsset**](doc//AssetsApi.md#downloadasset) | **GET** /assets/{id}/original |
*AssetsApi* | [**getAllUserAssetsByDeviceId**](doc//AssetsApi.md#getalluserassetsbydeviceid) | **GET** /assets/device/{deviceId} | Get all asset of a device that are in the database, ID only.
*AssetsApi* | [**getAllUserAssetsByDeviceId**](doc//AssetsApi.md#getalluserassetsbydeviceid) | **GET** /assets/device/{deviceId} | getAllUserAssetsByDeviceId
*AssetsApi* | [**getAssetInfo**](doc//AssetsApi.md#getassetinfo) | **GET** /assets/{id} |
*AssetsApi* | [**getAssetStatistics**](doc//AssetsApi.md#getassetstatistics) | **GET** /assets/statistics |
*AssetsApi* | [**getMemoryLane**](doc//AssetsApi.md#getmemorylane) | **GET** /assets/memory-lane |
*AssetsApi* | [**getRandom**](doc//AssetsApi.md#getrandom) | **GET** /assets/random |
*AssetsApi* | [**playAssetVideo**](doc//AssetsApi.md#playassetvideo) | **GET** /assets/{id}/video/playback |
*AssetsApi* | [**replaceAsset**](doc//AssetsApi.md#replaceasset) | **PUT** /assets/{id}/original | Replace the asset with new file, without changing its id
*AssetsApi* | [**replaceAsset**](doc//AssetsApi.md#replaceasset) | **PUT** /assets/{id}/original | replaceAsset
*AssetsApi* | [**runAssetJobs**](doc//AssetsApi.md#runassetjobs) | **POST** /assets/jobs |
*AssetsApi* | [**updateAsset**](doc//AssetsApi.md#updateasset) | **PUT** /assets/{id} |
*AssetsApi* | [**updateAssets**](doc//AssetsApi.md#updateassets) | **PUT** /assets |

16
mobile/openapi/lib/api/assets_api.dart generated
View File

@@ -16,6 +16,8 @@ class AssetsApi {
final ApiClient apiClient;
/// checkBulkUpload
///
/// Checks if assets exist by checksums
///
/// Note: This method returns the HTTP [Response].
@@ -48,6 +50,8 @@ class AssetsApi {
);
}
/// checkBulkUpload
///
/// Checks if assets exist by checksums
///
/// Parameters:
@@ -68,6 +72,8 @@ class AssetsApi {
return null;
}
/// checkExistingAssets
///
/// Checks if multiple assets exist on the server and returns all existing - used by background backup
///
/// Note: This method returns the HTTP [Response].
@@ -100,6 +106,8 @@ class AssetsApi {
);
}
/// checkExistingAssets
///
/// Checks if multiple assets exist on the server and returns all existing - used by background backup
///
/// Parameters:
@@ -215,6 +223,8 @@ class AssetsApi {
return null;
}
/// getAllUserAssetsByDeviceId
///
/// Get all asset of a device that are in the database, ID only.
///
/// Note: This method returns the HTTP [Response].
@@ -248,6 +258,8 @@ class AssetsApi {
);
}
/// getAllUserAssetsByDeviceId
///
/// Get all asset of a device that are in the database, ID only.
///
/// Parameters:
@@ -564,6 +576,8 @@ class AssetsApi {
return null;
}
/// replaceAsset
///
/// Replace the asset with new file, without changing its id
///
/// Note: This method returns the HTTP [Response].
@@ -645,6 +659,8 @@ class AssetsApi {
);
}
/// replaceAsset
///
/// Replace the asset with new file, without changing its id
///
/// Parameters: