feat(server): create a person with optional values (#7706)

* feat: create person dto

* chore: open api

* fix: e2e

* fix: web usage

mobile/openapi/.openapi-generator/FILES

@@ -104,6 +104,7 @@ doc/PeopleResponseDto.md
 doc/PeopleUpdateDto.md
 doc/PeopleUpdateItem.md
 doc/PersonApi.md
+doc/PersonCreateDto.md
 doc/PersonResponseDto.md
 doc/PersonStatisticsResponseDto.md
 doc/PersonUpdateDto.md
@@ -306,6 +307,7 @@ lib/model/path_type.dart
 lib/model/people_response_dto.dart
 lib/model/people_update_dto.dart
 lib/model/people_update_item.dart
+lib/model/person_create_dto.dart
 lib/model/person_response_dto.dart
 lib/model/person_statistics_response_dto.dart
 lib/model/person_update_dto.dart
@@ -485,6 +487,7 @@ test/people_response_dto_test.dart
 test/people_update_dto_test.dart
 test/people_update_item_test.dart
 test/person_api_test.dart
+test/person_create_dto_test.dart
 test/person_response_dto_test.dart
 test/person_statistics_response_dto_test.dart
 test/person_update_dto_test.dart

mobile/openapi/README.md

@@ -303,6 +303,7 @@ Class | Method | HTTP request | Description
  - [PeopleResponseDto](doc//PeopleResponseDto.md)
  - [PeopleUpdateDto](doc//PeopleUpdateDto.md)
  - [PeopleUpdateItem](doc//PeopleUpdateItem.md)
+ - [PersonCreateDto](doc//PersonCreateDto.md)
  - [PersonResponseDto](doc//PersonResponseDto.md)
  - [PersonStatisticsResponseDto](doc//PersonStatisticsResponseDto.md)
  - [PersonUpdateDto](doc//PersonUpdateDto.md)

mobile/openapi/doc/PersonApi.md

@@ -22,7 +22,7 @@ Method | HTTP request | Description
 
 
 # **createPerson**
-> PersonResponseDto createPerson()
+> PersonResponseDto createPerson(personCreateDto)
 
 
 
@@ -45,9 +45,10 @@ import 'package:openapi/api.dart';
 //defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);
 
 final api_instance = PersonApi();
+final personCreateDto = PersonCreateDto(); // PersonCreateDto | 
 
 try {
-    final result = api_instance.createPerson();
+    final result = api_instance.createPerson(personCreateDto);
     print(result);
 } catch (e) {
     print('Exception when calling PersonApi->createPerson: $e\n');
@@ -55,7 +56,10 @@ try {
 ```
 
 ### Parameters
-This endpoint does not need any parameter.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **personCreateDto** | [**PersonCreateDto**](PersonCreateDto.md)|  | 
 
 ### Return type
 
@@ -67,7 +71,7 @@ This endpoint does not need any parameter.
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
  - **Accept**: application/json
 
 [[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)

mobile/openapi/doc/PersonCreateDto.md

@@ -0,0 +1,17 @@
+# openapi.model.PersonCreateDto
+
+## Load the model package
+```dart
+import 'package:openapi/api.dart';
+```
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**birthDate** | [**DateTime**](DateTime.md) | Person date of birth. Note: the mobile app cannot currently set the birth date to null. | [optional] 
+**isHidden** | **bool** | Person visibility | [optional] 
+**name** | **String** | Person name. | [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/lib/api.dart

@@ -138,6 +138,7 @@ part 'model/path_type.dart';
 part 'model/people_response_dto.dart';
 part 'model/people_update_dto.dart';
 part 'model/people_update_item.dart';
+part 'model/person_create_dto.dart';
 part 'model/person_response_dto.dart';
 part 'model/person_statistics_response_dto.dart';
 part 'model/person_update_dto.dart';

mobile/openapi/lib/api/person_api.dart

@@ -17,18 +17,21 @@ class PersonApi {
   final ApiClient apiClient;
 
   /// Performs an HTTP 'POST /person' operation and returns the [Response].
-  Future<Response> createPersonWithHttpInfo() async {
+  /// Parameters:
+  ///
+  /// * [PersonCreateDto] personCreateDto (required):
+  Future<Response> createPersonWithHttpInfo(PersonCreateDto personCreateDto,) async {
     // ignore: prefer_const_declarations
     final path = r'/person';
 
     // ignore: prefer_final_locals
-    Object? postBody;
+    Object? postBody = personCreateDto;
 
     final queryParams = <QueryParam>[];
     final headerParams = <String, String>{};
     final formParams = <String, String>{};
 
-    const contentTypes = <String>[];
+    const contentTypes = <String>['application/json'];
 
 
     return apiClient.invokeAPI(
@@ -42,8 +45,11 @@ class PersonApi {
     );
   }
 
-  Future<PersonResponseDto?> createPerson() async {
-    final response = await createPersonWithHttpInfo();
+  /// Parameters:
+  ///
+  /// * [PersonCreateDto] personCreateDto (required):
+  Future<PersonResponseDto?> createPerson(PersonCreateDto personCreateDto,) async {
+    final response = await createPersonWithHttpInfo(personCreateDto,);
     if (response.statusCode >= HttpStatus.badRequest) {
       throw ApiException(response.statusCode, await _decodeBodyBytes(response));
     }

mobile/openapi/lib/api_client.dart

@@ -358,6 +358,8 @@ class ApiClient {
           return PeopleUpdateDto.fromJson(value);
         case 'PeopleUpdateItem':
           return PeopleUpdateItem.fromJson(value);
+        case 'PersonCreateDto':
+          return PersonCreateDto.fromJson(value);
         case 'PersonResponseDto':
           return PersonResponseDto.fromJson(value);
         case 'PersonStatisticsResponseDto':

mobile/openapi/lib/model/person_create_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 PersonCreateDto {
+  /// Returns a new [PersonCreateDto] instance.
+  PersonCreateDto({
+    this.birthDate,
+    this.isHidden,
+    this.name,
+  });
+
+  /// Person date of birth. Note: the mobile app cannot currently set the birth date to null.
+  DateTime? birthDate;
+
+  /// Person visibility
+  ///
+  /// 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? isHidden;
+
+  /// Person name.
+  ///
+  /// 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.
+  ///
+  String? name;
+
+  @override
+  bool operator ==(Object other) => identical(this, other) || other is PersonCreateDto &&
+    other.birthDate == birthDate &&
+    other.isHidden == isHidden &&
+    other.name == name;
+
+  @override
+  int get hashCode =>
+    // ignore: unnecessary_parenthesis
+    (birthDate == null ? 0 : birthDate!.hashCode) +
+    (isHidden == null ? 0 : isHidden!.hashCode) +
+    (name == null ? 0 : name!.hashCode);
+
+  @override
+  String toString() => 'PersonCreateDto[birthDate=$birthDate, isHidden=$isHidden, name=$name]';
+
+  Map<String, dynamic> toJson() {
+    final json = <String, dynamic>{};
+    if (this.birthDate != null) {
+      json[r'birthDate'] = _dateFormatter.format(this.birthDate!.toUtc());
+    } else {
+    //  json[r'birthDate'] = null;
+    }
+    if (this.isHidden != null) {
+      json[r'isHidden'] = this.isHidden;
+    } else {
+    //  json[r'isHidden'] = null;
+    }
+    if (this.name != null) {
+      json[r'name'] = this.name;
+    } else {
+    //  json[r'name'] = null;
+    }
+    return json;
+  }
+
+  /// Returns a new [PersonCreateDto] instance and imports its values from
+  /// [value] if it's a [Map], null otherwise.
+  // ignore: prefer_constructors_over_static_methods
+  static PersonCreateDto? fromJson(dynamic value) {
+    if (value is Map) {
+      final json = value.cast<String, dynamic>();
+
+      return PersonCreateDto(
+        birthDate: mapDateTime(json, r'birthDate', r''),
+        isHidden: mapValueOfType<bool>(json, r'isHidden'),
+        name: mapValueOfType<String>(json, r'name'),
+      );
+    }
+    return null;
+  }
+
+  static List<PersonCreateDto> listFromJson(dynamic json, {bool growable = false,}) {
+    final result = <PersonCreateDto>[];
+    if (json is List && json.isNotEmpty) {
+      for (final row in json) {
+        final value = PersonCreateDto.fromJson(row);
+        if (value != null) {
+          result.add(value);
+        }
+      }
+    }
+    return result.toList(growable: growable);
+  }
+
+  static Map<String, PersonCreateDto> mapFromJson(dynamic json) {
+    final map = <String, PersonCreateDto>{};
+    if (json is Map && json.isNotEmpty) {
+      json = json.cast<String, dynamic>(); // ignore: parameter_assignments
+      for (final entry in json.entries) {
+        final value = PersonCreateDto.fromJson(entry.value);
+        if (value != null) {
+          map[entry.key] = value;
+        }
+      }
+    }
+    return map;
+  }
+
+  // maps a json object with a list of PersonCreateDto-objects as value to a dart map
+  static Map<String, List<PersonCreateDto>> mapListFromJson(dynamic json, {bool growable = false,}) {
+    final map = <String, List<PersonCreateDto>>{};
+    if (json is Map && json.isNotEmpty) {
+      // ignore: parameter_assignments
+      json = json.cast<String, dynamic>();
+      for (final entry in json.entries) {
+        map[entry.key] = PersonCreateDto.listFromJson(entry.value, growable: growable,);
+      }
+    }
+    return map;
+  }
+
+  /// The list of required keys that must be present in a JSON.
+  static const requiredKeys = <String>{
+  };
+}
+

mobile/openapi/test/person_api_test.dart

@@ -17,7 +17,7 @@ void main() {
   // final instance = PersonApi();
 
   group('tests for PersonApi', () {
-    //Future<PersonResponseDto> createPerson() async
+    //Future<PersonResponseDto> createPerson(PersonCreateDto personCreateDto) async
     test('test createPerson', () async {
       // TODO
     });

mobile/openapi/test/person_create_dto_test.dart

@@ -0,0 +1,40 @@
+//
+// 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 PersonCreateDto
+void main() {
+  // final instance = PersonCreateDto();
+
+  group('test PersonCreateDto', () {
+    // Person date of birth. Note: the mobile app cannot currently set the birth date to null.
+    // DateTime birthDate
+    test('to test the property `birthDate`', () async {
+      // TODO
+    });
+
+    // Person visibility
+    // bool isHidden
+    test('to test the property `isHidden`', () async {
+      // TODO
+    });
+
+    // Person name.
+    // String name
+    test('to test the property `name`', () async {
+      // TODO
+    });
+
+
+  });
+
+}