feat(server): make is favorite optional on asset upload (#4865)

* feat(server): make isFavorite optional

* chore: open api

* chore: e2e

mobile/openapi/doc/AssetApi.md

@@ -1696,7 +1696,7 @@ void (empty response body)
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **uploadFile**
-> AssetFileUploadResponseDto uploadFile(assetData, deviceAssetId, deviceId, fileCreatedAt, fileModifiedAt, isFavorite, key, duration, isArchived, isExternal, isOffline, isReadOnly, isVisible, libraryId, livePhotoData, sidecarData)
+> AssetFileUploadResponseDto uploadFile(assetData, deviceAssetId, deviceId, fileCreatedAt, fileModifiedAt, key, duration, isArchived, isExternal, isFavorite, isOffline, isReadOnly, isVisible, libraryId, livePhotoData, sidecarData)
 
 
 
@@ -1724,11 +1724,11 @@ final deviceAssetId = deviceAssetId_example; // String |
 final deviceId = deviceId_example; // String | 
 final fileCreatedAt = 2013-10-20T19:20:30+01:00; // DateTime | 
 final fileModifiedAt = 2013-10-20T19:20:30+01:00; // DateTime | 
-final isFavorite = true; // bool | 
 final key = key_example; // String | 
 final duration = duration_example; // String | 
 final isArchived = true; // bool | 
 final isExternal = true; // bool | 
+final isFavorite = true; // bool | 
 final isOffline = true; // bool | 
 final isReadOnly = true; // bool | 
 final isVisible = true; // bool | 
@@ -1737,7 +1737,7 @@ final livePhotoData = BINARY_DATA_HERE; // MultipartFile |
 final sidecarData = BINARY_DATA_HERE; // MultipartFile | 
 
 try {
-    final result = api_instance.uploadFile(assetData, deviceAssetId, deviceId, fileCreatedAt, fileModifiedAt, isFavorite, key, duration, isArchived, isExternal, isOffline, isReadOnly, isVisible, libraryId, livePhotoData, sidecarData);
+    final result = api_instance.uploadFile(assetData, deviceAssetId, deviceId, fileCreatedAt, fileModifiedAt, key, duration, isArchived, isExternal, isFavorite, isOffline, isReadOnly, isVisible, libraryId, livePhotoData, sidecarData);
     print(result);
 } catch (e) {
     print('Exception when calling AssetApi->uploadFile: $e\n');
@@ -1753,11 +1753,11 @@ Name | Type | Description  | Notes
  **deviceId** | **String**|  | 
  **fileCreatedAt** | **DateTime**|  | 
  **fileModifiedAt** | **DateTime**|  | 
- **isFavorite** | **bool**|  | 
  **key** | **String**|  | [optional] 
  **duration** | **String**|  | [optional] 
  **isArchived** | **bool**|  | [optional] 
  **isExternal** | **bool**|  | [optional] 
+ **isFavorite** | **bool**|  | [optional] 
  **isOffline** | **bool**|  | [optional] 
  **isReadOnly** | **bool**|  | [optional] 
  **isVisible** | **bool**|  | [optional] 

mobile/openapi/doc/ImportAssetDto.md

@@ -16,7 +16,7 @@ Name | Type | Description | Notes
 **fileModifiedAt** | [**DateTime**](DateTime.md) |  | 
 **isArchived** | **bool** |  | [optional] 
 **isExternal** | **bool** |  | [optional] 
-**isFavorite** | **bool** |  | 
+**isFavorite** | **bool** |  | [optional] 
 **isOffline** | **bool** |  | [optional] 
 **isReadOnly** | **bool** |  | [optional] [default to true]
 **isVisible** | **bool** |  | [optional] 

mobile/openapi/lib/api/asset_api.dart

@@ -1660,8 +1660,6 @@ class AssetApi {
   ///
   /// * [DateTime] fileModifiedAt (required):
   ///
-  /// * [bool] isFavorite (required):
-  ///
   /// * [String] key:
   ///
   /// * [String] duration:
@@ -1670,6 +1668,8 @@ class AssetApi {
   ///
   /// * [bool] isExternal:
   ///
+  /// * [bool] isFavorite:
+  ///
   /// * [bool] isOffline:
   ///
   /// * [bool] isReadOnly:
@@ -1681,7 +1681,7 @@ class AssetApi {
   /// * [MultipartFile] livePhotoData:
   ///
   /// * [MultipartFile] sidecarData:
-  Future<Response> uploadFileWithHttpInfo(MultipartFile assetData, String deviceAssetId, String deviceId, DateTime fileCreatedAt, DateTime fileModifiedAt, bool isFavorite, { String? key, String? duration, bool? isArchived, bool? isExternal, bool? isOffline, bool? isReadOnly, bool? isVisible, String? libraryId, MultipartFile? livePhotoData, MultipartFile? sidecarData, }) async {
+  Future<Response> uploadFileWithHttpInfo(MultipartFile assetData, String deviceAssetId, String deviceId, DateTime fileCreatedAt, DateTime fileModifiedAt, { String? key, String? duration, bool? isArchived, bool? isExternal, bool? isFavorite, bool? isOffline, bool? isReadOnly, bool? isVisible, String? libraryId, MultipartFile? livePhotoData, MultipartFile? sidecarData, }) async {
     // ignore: prefer_const_declarations
     final path = r'/asset/upload';
 
@@ -1790,8 +1790,6 @@ class AssetApi {
   ///
   /// * [DateTime] fileModifiedAt (required):
   ///
-  /// * [bool] isFavorite (required):
-  ///
   /// * [String] key:
   ///
   /// * [String] duration:
@@ -1800,6 +1798,8 @@ class AssetApi {
   ///
   /// * [bool] isExternal:
   ///
+  /// * [bool] isFavorite:
+  ///
   /// * [bool] isOffline:
   ///
   /// * [bool] isReadOnly:
@@ -1811,8 +1811,8 @@ class AssetApi {
   /// * [MultipartFile] livePhotoData:
   ///
   /// * [MultipartFile] sidecarData:
-  Future<AssetFileUploadResponseDto?> uploadFile(MultipartFile assetData, String deviceAssetId, String deviceId, DateTime fileCreatedAt, DateTime fileModifiedAt, bool isFavorite, { String? key, String? duration, bool? isArchived, bool? isExternal, bool? isOffline, bool? isReadOnly, bool? isVisible, String? libraryId, MultipartFile? livePhotoData, MultipartFile? sidecarData, }) async {
-    final response = await uploadFileWithHttpInfo(assetData, deviceAssetId, deviceId, fileCreatedAt, fileModifiedAt, isFavorite,  key: key, duration: duration, isArchived: isArchived, isExternal: isExternal, isOffline: isOffline, isReadOnly: isReadOnly, isVisible: isVisible, libraryId: libraryId, livePhotoData: livePhotoData, sidecarData: sidecarData, );
+  Future<AssetFileUploadResponseDto?> uploadFile(MultipartFile assetData, String deviceAssetId, String deviceId, DateTime fileCreatedAt, DateTime fileModifiedAt, { String? key, String? duration, bool? isArchived, bool? isExternal, bool? isFavorite, bool? isOffline, bool? isReadOnly, bool? isVisible, String? libraryId, MultipartFile? livePhotoData, MultipartFile? sidecarData, }) async {
+    final response = await uploadFileWithHttpInfo(assetData, deviceAssetId, deviceId, fileCreatedAt, fileModifiedAt,  key: key, duration: duration, isArchived: isArchived, isExternal: isExternal, isFavorite: isFavorite, isOffline: isOffline, isReadOnly: isReadOnly, isVisible: isVisible, libraryId: libraryId, livePhotoData: livePhotoData, sidecarData: sidecarData, );
     if (response.statusCode >= HttpStatus.badRequest) {
       throw ApiException(response.statusCode, await _decodeBodyBytes(response));
     }

mobile/openapi/lib/model/import_asset_dto.dart

@@ -21,7 +21,7 @@ class ImportAssetDto {
     required this.fileModifiedAt,
     this.isArchived,
     this.isExternal,
-    required this.isFavorite,
+    this.isFavorite,
     this.isOffline,
     this.isReadOnly = true,
     this.isVisible,
@@ -63,7 +63,13 @@ class ImportAssetDto {
   ///
   bool? isExternal;
 
-  bool isFavorite;
+  ///
+  /// Please note: This property should have been non-nullable! Since the specification file
+  /// does not include a default value (using the "default:" property), however, the generated
+  /// source code must fall back to having a nullable type.
+  /// Consider adding a "default:" property in the specification file to hide this note.
+  ///
+  bool? isFavorite;
 
   ///
   /// Please note: This property should have been non-nullable! Since the specification file
@@ -127,7 +133,7 @@ class ImportAssetDto {
     (fileModifiedAt.hashCode) +
     (isArchived == null ? 0 : isArchived!.hashCode) +
     (isExternal == null ? 0 : isExternal!.hashCode) +
-    (isFavorite.hashCode) +
+    (isFavorite == null ? 0 : isFavorite!.hashCode) +
     (isOffline == null ? 0 : isOffline!.hashCode) +
     (isReadOnly.hashCode) +
     (isVisible == null ? 0 : isVisible!.hashCode) +
@@ -159,7 +165,11 @@ class ImportAssetDto {
     } else {
     //  json[r'isExternal'] = null;
     }
+    if (this.isFavorite != null) {
       json[r'isFavorite'] = this.isFavorite;
+    } else {
+    //  json[r'isFavorite'] = null;
+    }
     if (this.isOffline != null) {
       json[r'isOffline'] = this.isOffline;
     } else {
@@ -200,7 +210,7 @@ class ImportAssetDto {
         fileModifiedAt: mapDateTime(json, r'fileModifiedAt', '')!,
         isArchived: mapValueOfType<bool>(json, r'isArchived'),
         isExternal: mapValueOfType<bool>(json, r'isExternal'),
-        isFavorite: mapValueOfType<bool>(json, r'isFavorite')!,
+        isFavorite: mapValueOfType<bool>(json, r'isFavorite'),
         isOffline: mapValueOfType<bool>(json, r'isOffline'),
         isReadOnly: mapValueOfType<bool>(json, r'isReadOnly') ?? true,
         isVisible: mapValueOfType<bool>(json, r'isVisible'),
@@ -258,7 +268,6 @@ class ImportAssetDto {
     'deviceId',
     'fileCreatedAt',
     'fileModifiedAt',
-    'isFavorite',
   };
 }
 

mobile/openapi/test/asset_api_test.dart

@@ -172,7 +172,7 @@ void main() {
       // TODO
     });
 
-    //Future<AssetFileUploadResponseDto> uploadFile(MultipartFile assetData, String deviceAssetId, String deviceId, DateTime fileCreatedAt, DateTime fileModifiedAt, bool isFavorite, { String key, String duration, bool isArchived, bool isExternal, bool isOffline, bool isReadOnly, bool isVisible, String libraryId, MultipartFile livePhotoData, MultipartFile sidecarData }) async
+    //Future<AssetFileUploadResponseDto> uploadFile(MultipartFile assetData, String deviceAssetId, String deviceId, DateTime fileCreatedAt, DateTime fileModifiedAt, { String key, String duration, bool isArchived, bool isExternal, bool isFavorite, bool isOffline, bool isReadOnly, bool isVisible, String libraryId, MultipartFile livePhotoData, MultipartFile sidecarData }) async
     test('test uploadFile', () async {
       // TODO
     });