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

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
mobile/openapi/lib/api

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: