feat(server) Extend PUT /album/:id/assets endpoint (#857)

* Add new query parameter to API endpoint that allows adding assets to albums which potentially contain assets that are already part of this album.

* Change API endpoint

* Generate new APIs

* Fixed test

Co-authored-by: Alex Tran <alex.tran1502@gmail.com>

mobile/openapi/.openapi-generator/FILES

@@ -3,6 +3,7 @@
 README.md
 analysis_options.yaml
 doc/AddAssetsDto.md
+doc/AddAssetsResponseDto.md
 doc/AddUsersDto.md
 doc/AdminSignupResponseDto.md
 doc/AlbumApi.md
@@ -82,6 +83,7 @@ lib/auth/http_basic_auth.dart
 lib/auth/http_bearer_auth.dart
 lib/auth/oauth.dart
 lib/model/add_assets_dto.dart
+lib/model/add_assets_response_dto.dart
 lib/model/add_users_dto.dart
 lib/model/admin_signup_response_dto.dart
 lib/model/album_count_response_dto.dart
@@ -137,5 +139,3 @@ lib/model/user_count_response_dto.dart
 lib/model/user_response_dto.dart
 lib/model/validate_access_token_response_dto.dart
 pubspec.yaml
-test/check_existing_assets_dto_test.dart
-test/check_existing_assets_response_dto_test.dart

mobile/openapi/README.md

@@ -118,6 +118,7 @@ Class | Method | HTTP request | Description
 ## Documentation For Models
 
  - [AddAssetsDto](doc//AddAssetsDto.md)
+ - [AddAssetsResponseDto](doc//AddAssetsResponseDto.md)
  - [AddUsersDto](doc//AddUsersDto.md)
  - [AdminSignupResponseDto](doc//AdminSignupResponseDto.md)
  - [AlbumCountResponseDto](doc//AlbumCountResponseDto.md)

mobile/openapi/doc/AddAssetsResponseDto.md

@@ -0,0 +1,17 @@
+# openapi.model.AddAssetsResponseDto
+
+## Load the model package
+```dart
+import 'package:openapi/api.dart';
+```
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successfullyAdded** | **int** |  | 
+**alreadyInAlbum** | **List<String>** |  | [default to const []]
+**album** | [**AlbumResponseDto**](AlbumResponseDto.md) |  | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

mobile/openapi/doc/AlbumApi.md

@@ -22,7 +22,7 @@ Method | HTTP request | Description
 
 
 # **addAssetsToAlbum**
-> AlbumResponseDto addAssetsToAlbum(albumId, addAssetsDto)
+> AddAssetsResponseDto addAssetsToAlbum(albumId, addAssetsDto)
 
 
 
@@ -57,7 +57,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**AlbumResponseDto**](AlbumResponseDto.md)
+[**AddAssetsResponseDto**](AddAssetsResponseDto.md)
 
 ### Authorization
 

mobile/openapi/lib/api.dart

@@ -36,6 +36,7 @@ part 'api/server_info_api.dart';
 part 'api/user_api.dart';
 
 part 'model/add_assets_dto.dart';
+part 'model/add_assets_response_dto.dart';
 part 'model/add_users_dto.dart';
 part 'model/admin_signup_response_dto.dart';
 part 'model/album_count_response_dto.dart';

mobile/openapi/lib/api/album_api.dart

@@ -53,7 +53,7 @@ class AlbumApi {
   /// * [String] albumId (required):
   ///
   /// * [AddAssetsDto] addAssetsDto (required):
-  Future<AlbumResponseDto?> addAssetsToAlbum(String albumId, AddAssetsDto addAssetsDto,) async {
+  Future<AddAssetsResponseDto?> addAssetsToAlbum(String albumId, AddAssetsDto addAssetsDto,) async {
     final response = await addAssetsToAlbumWithHttpInfo(albumId, addAssetsDto,);
     if (response.statusCode >= HttpStatus.badRequest) {
       throw ApiException(response.statusCode, await _decodeBodyBytes(response));
@@ -62,7 +62,7 @@ class AlbumApi {
     // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
     // FormatException when trying to decode an empty string.
     if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
-      return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'AlbumResponseDto',) as AlbumResponseDto;
+      return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'AddAssetsResponseDto',) as AddAssetsResponseDto;
     
     }
     return null;

mobile/openapi/lib/api_client.dart

@@ -194,6 +194,8 @@ class ApiClient {
           return value is DateTime ? value : DateTime.tryParse(value);
         case 'AddAssetsDto':
           return AddAssetsDto.fromJson(value);
+        case 'AddAssetsResponseDto':
+          return AddAssetsResponseDto.fromJson(value);
         case 'AddUsersDto':
           return AddUsersDto.fromJson(value);
         case 'AdminSignupResponseDto':

mobile/openapi/lib/model/add_assets_response_dto.dart

@@ -0,0 +1,138 @@
+//
+// AUTO-GENERATED FILE, DO NOT MODIFY!
+//
+// @dart=2.12
+
+// ignore_for_file: unused_element, unused_import
+// ignore_for_file: always_put_required_named_parameters_first
+// ignore_for_file: constant_identifier_names
+// ignore_for_file: lines_longer_than_80_chars
+
+part of openapi.api;
+
+class AddAssetsResponseDto {
+  /// Returns a new [AddAssetsResponseDto] instance.
+  AddAssetsResponseDto({
+    required this.successfullyAdded,
+    this.alreadyInAlbum = const [],
+    this.album,
+  });
+
+  int successfullyAdded;
+
+  List<String> alreadyInAlbum;
+
+  ///
+  /// 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.
+  ///
+  AlbumResponseDto? album;
+
+  @override
+  bool operator ==(Object other) => identical(this, other) || other is AddAssetsResponseDto &&
+     other.successfullyAdded == successfullyAdded &&
+     other.alreadyInAlbum == alreadyInAlbum &&
+     other.album == album;
+
+  @override
+  int get hashCode =>
+    // ignore: unnecessary_parenthesis
+    (successfullyAdded.hashCode) +
+    (alreadyInAlbum.hashCode) +
+    (album == null ? 0 : album!.hashCode);
+
+  @override
+  String toString() => 'AddAssetsResponseDto[successfullyAdded=$successfullyAdded, alreadyInAlbum=$alreadyInAlbum, album=$album]';
+
+  Map<String, dynamic> toJson() {
+    final _json = <String, dynamic>{};
+      _json[r'successfullyAdded'] = successfullyAdded;
+      _json[r'alreadyInAlbum'] = alreadyInAlbum;
+    if (album != null) {
+      _json[r'album'] = album;
+    } else {
+      _json[r'album'] = null;
+    }
+    return _json;
+  }
+
+  /// Returns a new [AddAssetsResponseDto] instance and imports its values from
+  /// [value] if it's a [Map], null otherwise.
+  // ignore: prefer_constructors_over_static_methods
+  static AddAssetsResponseDto? fromJson(dynamic value) {
+    if (value is Map) {
+      final json = value.cast<String, dynamic>();
+
+      // Ensure that the map contains the required keys.
+      // Note 1: the values aren't checked for validity beyond being non-null.
+      // Note 2: this code is stripped in release mode!
+      assert(() {
+        requiredKeys.forEach((key) {
+          assert(json.containsKey(key), 'Required key "AddAssetsResponseDto[$key]" is missing from JSON.');
+          assert(json[key] != null, 'Required key "AddAssetsResponseDto[$key]" has a null value in JSON.');
+        });
+        return true;
+      }());
+
+      return AddAssetsResponseDto(
+        successfullyAdded: mapValueOfType<int>(json, r'successfullyAdded')!,
+        alreadyInAlbum: json[r'alreadyInAlbum'] is List
+            ? (json[r'alreadyInAlbum'] as List).cast<String>()
+            : const [],
+        album: AlbumResponseDto.fromJson(json[r'album']),
+      );
+    }
+    return null;
+  }
+
+  static List<AddAssetsResponseDto>? listFromJson(dynamic json, {bool growable = false,}) {
+    final result = <AddAssetsResponseDto>[];
+    if (json is List && json.isNotEmpty) {
+      for (final row in json) {
+        final value = AddAssetsResponseDto.fromJson(row);
+        if (value != null) {
+          result.add(value);
+        }
+      }
+    }
+    return result.toList(growable: growable);
+  }
+
+  static Map<String, AddAssetsResponseDto> mapFromJson(dynamic json) {
+    final map = <String, AddAssetsResponseDto>{};
+    if (json is Map && json.isNotEmpty) {
+      json = json.cast<String, dynamic>(); // ignore: parameter_assignments
+      for (final entry in json.entries) {
+        final value = AddAssetsResponseDto.fromJson(entry.value);
+        if (value != null) {
+          map[entry.key] = value;
+        }
+      }
+    }
+    return map;
+  }
+
+  // maps a json object with a list of AddAssetsResponseDto-objects as value to a dart map
+  static Map<String, List<AddAssetsResponseDto>> mapListFromJson(dynamic json, {bool growable = false,}) {
+    final map = <String, List<AddAssetsResponseDto>>{};
+    if (json is Map && json.isNotEmpty) {
+      json = json.cast<String, dynamic>(); // ignore: parameter_assignments
+      for (final entry in json.entries) {
+        final value = AddAssetsResponseDto.listFromJson(entry.value, growable: growable,);
+        if (value != null) {
+          map[entry.key] = value;
+        }
+      }
+    }
+    return map;
+  }
+
+  /// The list of required keys that must be present in a JSON.
+  static const requiredKeys = <String>{
+    'successfullyAdded',
+    'alreadyInAlbum',
+  };
+}
+

mobile/openapi/test/add_assets_response_dto_test.dart

@@ -0,0 +1,37 @@
+//
+// AUTO-GENERATED FILE, DO NOT MODIFY!
+//
+// @dart=2.12
+
+// ignore_for_file: unused_element, unused_import
+// ignore_for_file: always_put_required_named_parameters_first
+// ignore_for_file: constant_identifier_names
+// ignore_for_file: lines_longer_than_80_chars
+
+import 'package:openapi/api.dart';
+import 'package:test/test.dart';
+
+// tests for AddAssetsResponseDto
+void main() {
+  // final instance = AddAssetsResponseDto();
+
+  group('test AddAssetsResponseDto', () {
+    // int successfullyAdded
+    test('to test the property `successfullyAdded`', () async {
+      // TODO
+    });
+
+    // List<String> alreadyInAlbum (default value: const [])
+    test('to test the property `alreadyInAlbum`', () async {
+      // TODO
+    });
+
+    // AlbumResponseDto album
+    test('to test the property `album`', () async {
+      // TODO
+    });
+
+
+  });
+
+}