mirror of
https://github.com/immich-app/immich
synced 2025-11-14 17:36:12 +00:00
feat: endpoint descriptions (#23813)
This commit is contained in:
Jason Rasmussen
GitHub
parent
896665bca9
commit
edde0f93ae
76 changed files with 4193 additions and 1663 deletions
167
mobile/openapi/lib/api/assets_api.dart
generated
167
mobile/openapi/lib/api/assets_api.dart
generated
|
|
@ -16,9 +16,9 @@ class AssetsApi {
|
|||
|
||||
final ApiClient apiClient;
|
||||
|
||||
/// checkBulkUpload
|
||||
/// Check bulk upload
|
||||
///
|
||||
/// Checks if assets exist by checksums. This endpoint requires the `asset.upload` permission.
|
||||
/// Determine which assets have already been uploaded to the server based on their SHA1 checksums.
|
||||
///
|
||||
/// Note: This method returns the HTTP [Response].
|
||||
///
|
||||
|
|
@ -50,9 +50,9 @@ class AssetsApi {
|
|||
);
|
||||
}
|
||||
|
||||
/// checkBulkUpload
|
||||
/// Check bulk upload
|
||||
///
|
||||
/// Checks if assets exist by checksums. This endpoint requires the `asset.upload` permission.
|
||||
/// Determine which assets have already been uploaded to the server based on their SHA1 checksums.
|
||||
///
|
||||
/// Parameters:
|
||||
///
|
||||
|
|
@ -72,7 +72,7 @@ class AssetsApi {
|
|||
return null;
|
||||
}
|
||||
|
||||
/// checkExistingAssets
|
||||
/// Check existing assets
|
||||
///
|
||||
/// Checks if multiple assets exist on the server and returns all existing - used by background backup
|
||||
///
|
||||
|
|
@ -106,7 +106,7 @@ class AssetsApi {
|
|||
);
|
||||
}
|
||||
|
||||
/// checkExistingAssets
|
||||
/// Check existing assets
|
||||
///
|
||||
/// Checks if multiple assets exist on the server and returns all existing - used by background backup
|
||||
///
|
||||
|
|
@ -128,7 +128,9 @@ class AssetsApi {
|
|||
return null;
|
||||
}
|
||||
|
||||
/// This endpoint requires the `asset.copy` permission.
|
||||
/// Copy asset
|
||||
///
|
||||
/// Copy asset information like albums, tags, etc. from one asset to another.
|
||||
///
|
||||
/// Note: This method returns the HTTP [Response].
|
||||
///
|
||||
|
|
@ -160,7 +162,9 @@ class AssetsApi {
|
|||
);
|
||||
}
|
||||
|
||||
/// This endpoint requires the `asset.copy` permission.
|
||||
/// Copy asset
|
||||
///
|
||||
/// Copy asset information like albums, tags, etc. from one asset to another.
|
||||
///
|
||||
/// Parameters:
|
||||
///
|
||||
|
|
@ -172,7 +176,9 @@ class AssetsApi {
|
|||
}
|
||||
}
|
||||
|
||||
/// This endpoint requires the `asset.update` permission.
|
||||
/// Delete asset metadata by key
|
||||
///
|
||||
/// Delete a specific metadata key-value pair associated with the specified asset.
|
||||
///
|
||||
/// Note: This method returns the HTTP [Response].
|
||||
///
|
||||
|
|
@ -208,7 +214,9 @@ class AssetsApi {
|
|||
);
|
||||
}
|
||||
|
||||
/// This endpoint requires the `asset.update` permission.
|
||||
/// Delete asset metadata by key
|
||||
///
|
||||
/// Delete a specific metadata key-value pair associated with the specified asset.
|
||||
///
|
||||
/// Parameters:
|
||||
///
|
||||
|
|
@ -222,7 +230,9 @@ class AssetsApi {
|
|||
}
|
||||
}
|
||||
|
||||
/// This endpoint requires the `asset.delete` permission.
|
||||
/// Delete assets
|
||||
///
|
||||
/// Deletes multiple assets at the same time.
|
||||
///
|
||||
/// Note: This method returns the HTTP [Response].
|
||||
///
|
||||
|
|
@ -254,7 +264,9 @@ class AssetsApi {
|
|||
);
|
||||
}
|
||||
|
||||
/// This endpoint requires the `asset.delete` permission.
|
||||
/// Delete assets
|
||||
///
|
||||
/// Deletes multiple assets at the same time.
|
||||
///
|
||||
/// Parameters:
|
||||
///
|
||||
|
|
@ -266,7 +278,9 @@ class AssetsApi {
|
|||
}
|
||||
}
|
||||
|
||||
/// This endpoint requires the `asset.download` permission.
|
||||
/// Download original asset
|
||||
///
|
||||
/// Downloads the original file of the specified asset.
|
||||
///
|
||||
/// Note: This method returns the HTTP [Response].
|
||||
///
|
||||
|
|
@ -310,7 +324,9 @@ class AssetsApi {
|
|||
);
|
||||
}
|
||||
|
||||
/// This endpoint requires the `asset.download` permission.
|
||||
/// Download original asset
|
||||
///
|
||||
/// Downloads the original file of the specified asset.
|
||||
///
|
||||
/// Parameters:
|
||||
///
|
||||
|
|
@ -334,9 +350,9 @@ class AssetsApi {
|
|||
return null;
|
||||
}
|
||||
|
||||
/// getAllUserAssetsByDeviceId
|
||||
/// Retrieve assets by device ID
|
||||
///
|
||||
/// Get all asset of a device that are in the database, ID only.
|
||||
/// This property was deprecated in v2.0.0. Get all asset of a device that are in the database, ID only.
|
||||
///
|
||||
/// Note: This method returns the HTTP [Response].
|
||||
///
|
||||
|
|
@ -369,9 +385,9 @@ class AssetsApi {
|
|||
);
|
||||
}
|
||||
|
||||
/// getAllUserAssetsByDeviceId
|
||||
/// Retrieve assets by device ID
|
||||
///
|
||||
/// Get all asset of a device that are in the database, ID only.
|
||||
/// This property was deprecated in v2.0.0. Get all asset of a device that are in the database, ID only.
|
||||
///
|
||||
/// Parameters:
|
||||
///
|
||||
|
|
@ -394,7 +410,9 @@ class AssetsApi {
|
|||
return null;
|
||||
}
|
||||
|
||||
/// This endpoint requires the `asset.read` permission.
|
||||
/// Retrieve an asset
|
||||
///
|
||||
/// Retrieve detailed information about a specific asset.
|
||||
///
|
||||
/// Note: This method returns the HTTP [Response].
|
||||
///
|
||||
|
|
@ -438,7 +456,9 @@ class AssetsApi {
|
|||
);
|
||||
}
|
||||
|
||||
/// This endpoint requires the `asset.read` permission.
|
||||
/// Retrieve an asset
|
||||
///
|
||||
/// Retrieve detailed information about a specific asset.
|
||||
///
|
||||
/// Parameters:
|
||||
///
|
||||
|
|
@ -462,7 +482,9 @@ class AssetsApi {
|
|||
return null;
|
||||
}
|
||||
|
||||
/// This endpoint requires the `asset.read` permission.
|
||||
/// Get asset metadata
|
||||
///
|
||||
/// Retrieve all metadata key-value pairs associated with the specified asset.
|
||||
///
|
||||
/// Note: This method returns the HTTP [Response].
|
||||
///
|
||||
|
|
@ -495,7 +517,9 @@ class AssetsApi {
|
|||
);
|
||||
}
|
||||
|
||||
/// This endpoint requires the `asset.read` permission.
|
||||
/// Get asset metadata
|
||||
///
|
||||
/// Retrieve all metadata key-value pairs associated with the specified asset.
|
||||
///
|
||||
/// Parameters:
|
||||
///
|
||||
|
|
@ -518,7 +542,9 @@ class AssetsApi {
|
|||
return null;
|
||||
}
|
||||
|
||||
/// This endpoint requires the `asset.read` permission.
|
||||
/// Retrieve asset metadata by key
|
||||
///
|
||||
/// Retrieve the value of a specific metadata key associated with the specified asset.
|
||||
///
|
||||
/// Note: This method returns the HTTP [Response].
|
||||
///
|
||||
|
|
@ -554,7 +580,9 @@ class AssetsApi {
|
|||
);
|
||||
}
|
||||
|
||||
/// This endpoint requires the `asset.read` permission.
|
||||
/// Retrieve asset metadata by key
|
||||
///
|
||||
/// Retrieve the value of a specific metadata key associated with the specified asset.
|
||||
///
|
||||
/// Parameters:
|
||||
///
|
||||
|
|
@ -576,7 +604,9 @@ class AssetsApi {
|
|||
return null;
|
||||
}
|
||||
|
||||
/// This endpoint requires the `asset.read` permission.
|
||||
/// Retrieve asset OCR data
|
||||
///
|
||||
/// Retrieve all OCR (Optical Character Recognition) data associated with the specified asset.
|
||||
///
|
||||
/// Note: This method returns the HTTP [Response].
|
||||
///
|
||||
|
|
@ -609,7 +639,9 @@ class AssetsApi {
|
|||
);
|
||||
}
|
||||
|
||||
/// This endpoint requires the `asset.read` permission.
|
||||
/// Retrieve asset OCR data
|
||||
///
|
||||
/// Retrieve all OCR (Optical Character Recognition) data associated with the specified asset.
|
||||
///
|
||||
/// Parameters:
|
||||
///
|
||||
|
|
@ -632,7 +664,9 @@ class AssetsApi {
|
|||
return null;
|
||||
}
|
||||
|
||||
/// This endpoint requires the `asset.statistics` permission.
|
||||
/// Get asset statistics
|
||||
///
|
||||
/// Retrieve various statistics about the assets owned by the authenticated user.
|
||||
///
|
||||
/// Note: This method returns the HTTP [Response].
|
||||
///
|
||||
|
|
@ -678,7 +712,9 @@ class AssetsApi {
|
|||
);
|
||||
}
|
||||
|
||||
/// This endpoint requires the `asset.statistics` permission.
|
||||
/// Get asset statistics
|
||||
///
|
||||
/// Retrieve various statistics about the assets owned by the authenticated user.
|
||||
///
|
||||
/// Parameters:
|
||||
///
|
||||
|
|
@ -702,7 +738,9 @@ class AssetsApi {
|
|||
return null;
|
||||
}
|
||||
|
||||
/// This property was deprecated in v1.116.0. This endpoint requires the `asset.read` permission.
|
||||
/// Get random assets
|
||||
///
|
||||
/// This property was deprecated in v1.116.0. Retrieve a specified number of random assets for the authenticated user.
|
||||
///
|
||||
/// Note: This method returns the HTTP [Response].
|
||||
///
|
||||
|
|
@ -738,7 +776,9 @@ class AssetsApi {
|
|||
);
|
||||
}
|
||||
|
||||
/// This property was deprecated in v1.116.0. This endpoint requires the `asset.read` permission.
|
||||
/// Get random assets
|
||||
///
|
||||
/// This property was deprecated in v1.116.0. Retrieve a specified number of random assets for the authenticated user.
|
||||
///
|
||||
/// Parameters:
|
||||
///
|
||||
|
|
@ -761,7 +801,9 @@ class AssetsApi {
|
|||
return null;
|
||||
}
|
||||
|
||||
/// This endpoint requires the `asset.view` permission.
|
||||
/// Play asset video
|
||||
///
|
||||
/// Streams the video file for the specified asset. This endpoint also supports byte range requests.
|
||||
///
|
||||
/// Note: This method returns the HTTP [Response].
|
||||
///
|
||||
|
|
@ -805,7 +847,9 @@ class AssetsApi {
|
|||
);
|
||||
}
|
||||
|
||||
/// This endpoint requires the `asset.view` permission.
|
||||
/// Play asset video
|
||||
///
|
||||
/// Streams the video file for the specified asset. This endpoint also supports byte range requests.
|
||||
///
|
||||
/// Parameters:
|
||||
///
|
||||
|
|
@ -829,9 +873,9 @@ class AssetsApi {
|
|||
return null;
|
||||
}
|
||||
|
||||
/// Replace the asset with new file, without changing its id
|
||||
/// Replace asset
|
||||
///
|
||||
/// This property was deprecated in v1.142.0. Replace the asset with new file, without changing its id. This endpoint requires the `asset.replace` permission.
|
||||
/// This property was deprecated in v1.142.0. Replace the asset with new file, without changing its id.
|
||||
///
|
||||
/// Note: This method returns the HTTP [Response].
|
||||
///
|
||||
|
|
@ -923,9 +967,9 @@ class AssetsApi {
|
|||
);
|
||||
}
|
||||
|
||||
/// Replace the asset with new file, without changing its id
|
||||
/// Replace asset
|
||||
///
|
||||
/// This property was deprecated in v1.142.0. Replace the asset with new file, without changing its id. This endpoint requires the `asset.replace` permission.
|
||||
/// This property was deprecated in v1.142.0. Replace the asset with new file, without changing its id.
|
||||
///
|
||||
/// Parameters:
|
||||
///
|
||||
|
|
@ -963,7 +1007,12 @@ class AssetsApi {
|
|||
return null;
|
||||
}
|
||||
|
||||
/// Performs an HTTP 'POST /assets/jobs' operation and returns the [Response].
|
||||
/// Run an asset job
|
||||
///
|
||||
/// Run a specific job on a set of assets.
|
||||
///
|
||||
/// Note: This method returns the HTTP [Response].
|
||||
///
|
||||
/// Parameters:
|
||||
///
|
||||
/// * [AssetJobsDto] assetJobsDto (required):
|
||||
|
|
@ -992,6 +1041,10 @@ class AssetsApi {
|
|||
);
|
||||
}
|
||||
|
||||
/// Run an asset job
|
||||
///
|
||||
/// Run a specific job on a set of assets.
|
||||
///
|
||||
/// Parameters:
|
||||
///
|
||||
/// * [AssetJobsDto] assetJobsDto (required):
|
||||
|
|
@ -1002,7 +1055,9 @@ class AssetsApi {
|
|||
}
|
||||
}
|
||||
|
||||
/// This endpoint requires the `asset.update` permission.
|
||||
/// Update an asset
|
||||
///
|
||||
/// Update information of a specific asset.
|
||||
///
|
||||
/// Note: This method returns the HTTP [Response].
|
||||
///
|
||||
|
|
@ -1037,7 +1092,9 @@ class AssetsApi {
|
|||
);
|
||||
}
|
||||
|
||||
/// This endpoint requires the `asset.update` permission.
|
||||
/// Update an asset
|
||||
///
|
||||
/// Update information of a specific asset.
|
||||
///
|
||||
/// Parameters:
|
||||
///
|
||||
|
|
@ -1059,7 +1116,9 @@ class AssetsApi {
|
|||
return null;
|
||||
}
|
||||
|
||||
/// This endpoint requires the `asset.update` permission.
|
||||
/// Update asset metadata
|
||||
///
|
||||
/// Update or add metadata key-value pairs for the specified asset.
|
||||
///
|
||||
/// Note: This method returns the HTTP [Response].
|
||||
///
|
||||
|
|
@ -1094,7 +1153,9 @@ class AssetsApi {
|
|||
);
|
||||
}
|
||||
|
||||
/// This endpoint requires the `asset.update` permission.
|
||||
/// Update asset metadata
|
||||
///
|
||||
/// Update or add metadata key-value pairs for the specified asset.
|
||||
///
|
||||
/// Parameters:
|
||||
///
|
||||
|
|
@ -1119,7 +1180,9 @@ class AssetsApi {
|
|||
return null;
|
||||
}
|
||||
|
||||
/// This endpoint requires the `asset.update` permission.
|
||||
/// Update assets
|
||||
///
|
||||
/// Updates multiple assets at the same time.
|
||||
///
|
||||
/// Note: This method returns the HTTP [Response].
|
||||
///
|
||||
|
|
@ -1151,7 +1214,9 @@ class AssetsApi {
|
|||
);
|
||||
}
|
||||
|
||||
/// This endpoint requires the `asset.update` permission.
|
||||
/// Update assets
|
||||
///
|
||||
/// Updates multiple assets at the same time.
|
||||
///
|
||||
/// Parameters:
|
||||
///
|
||||
|
|
@ -1163,7 +1228,9 @@ class AssetsApi {
|
|||
}
|
||||
}
|
||||
|
||||
/// This endpoint requires the `asset.upload` permission.
|
||||
/// Upload asset
|
||||
///
|
||||
/// Uploads a new asset to the server.
|
||||
///
|
||||
/// Note: This method returns the HTTP [Response].
|
||||
///
|
||||
|
|
@ -1290,7 +1357,9 @@ class AssetsApi {
|
|||
);
|
||||
}
|
||||
|
||||
/// This endpoint requires the `asset.upload` permission.
|
||||
/// Upload asset
|
||||
///
|
||||
/// Uploads a new asset to the server.
|
||||
///
|
||||
/// Parameters:
|
||||
///
|
||||
|
|
@ -1339,7 +1408,9 @@ class AssetsApi {
|
|||
return null;
|
||||
}
|
||||
|
||||
/// This endpoint requires the `asset.view` permission.
|
||||
/// View asset thumbnail
|
||||
///
|
||||
/// Retrieve the thumbnail image for the specified asset.
|
||||
///
|
||||
/// Note: This method returns the HTTP [Response].
|
||||
///
|
||||
|
|
@ -1388,7 +1459,9 @@ class AssetsApi {
|
|||
);
|
||||
}
|
||||
|
||||
/// This endpoint requires the `asset.view` permission.
|
||||
/// View asset thumbnail
|
||||
///
|
||||
/// Retrieve the thumbnail image for the specified asset.
|
||||
///
|
||||
/// Parameters:
|
||||
///
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue