feat(server) user-defined storage structure (#1098)

[Breaking] newly uploaded file will conform to the default structure of `{uploadLocation}/{userId}/year/year-month-day/filename.ext`
This commit is contained in:
Alex 2022-12-16 14:26:12 -06:00 committed by GitHub
parent 391d00bcb9
commit c754c860fd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
59 changed files with 1892 additions and 173 deletions

View file

@ -64,6 +64,8 @@ doc/SystemConfigApi.md
doc/SystemConfigDto.md
doc/SystemConfigFFmpegDto.md
doc/SystemConfigOAuthDto.md
doc/SystemConfigStorageTemplateDto.md
doc/SystemConfigTemplateStorageOptionDto.md
doc/TagApi.md
doc/TagResponseDto.md
doc/TagTypeEnum.md
@ -152,6 +154,8 @@ lib/model/smart_info_response_dto.dart
lib/model/system_config_dto.dart
lib/model/system_config_f_fmpeg_dto.dart
lib/model/system_config_o_auth_dto.dart
lib/model/system_config_storage_template_dto.dart
lib/model/system_config_template_storage_option_dto.dart
lib/model/tag_response_dto.dart
lib/model/tag_type_enum.dart
lib/model/thumbnail_format.dart
@ -227,6 +231,8 @@ test/system_config_api_test.dart
test/system_config_dto_test.dart
test/system_config_f_fmpeg_dto_test.dart
test/system_config_o_auth_dto_test.dart
test/system_config_storage_template_dto_test.dart
test/system_config_template_storage_option_dto_test.dart
test/tag_api_test.dart
test/tag_response_dto_test.dart
test/tag_type_enum_test.dart

View file

@ -3,7 +3,7 @@ Immich API
This Dart package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.38.0
- API version: 1.38.2
- Build package: org.openapitools.codegen.languages.DartClientCodegen
## Requirements
@ -113,6 +113,7 @@ Class | Method | HTTP request | Description
*ServerInfoApi* | [**pingServer**](doc//ServerInfoApi.md#pingserver) | **GET** /server-info/ping |
*SystemConfigApi* | [**getConfig**](doc//SystemConfigApi.md#getconfig) | **GET** /system-config |
*SystemConfigApi* | [**getDefaults**](doc//SystemConfigApi.md#getdefaults) | **GET** /system-config/defaults |
*SystemConfigApi* | [**getStorageTemplateOptions**](doc//SystemConfigApi.md#getstoragetemplateoptions) | **GET** /system-config/storage-template-options |
*SystemConfigApi* | [**updateConfig**](doc//SystemConfigApi.md#updateconfig) | **PUT** /system-config |
*TagApi* | [**create**](doc//TagApi.md#create) | **POST** /tag |
*TagApi* | [**delete**](doc//TagApi.md#delete) | **DELETE** /tag/{id} |
@ -186,6 +187,8 @@ Class | Method | HTTP request | Description
- [SystemConfigDto](doc//SystemConfigDto.md)
- [SystemConfigFFmpegDto](doc//SystemConfigFFmpegDto.md)
- [SystemConfigOAuthDto](doc//SystemConfigOAuthDto.md)
- [SystemConfigStorageTemplateDto](doc//SystemConfigStorageTemplateDto.md)
- [SystemConfigTemplateStorageOptionDto](doc//SystemConfigTemplateStorageOptionDto.md)
- [TagResponseDto](doc//TagResponseDto.md)
- [TagTypeEnum](doc//TagTypeEnum.md)
- [ThumbnailFormat](doc//ThumbnailFormat.md)

View file

@ -11,6 +11,7 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**getConfig**](SystemConfigApi.md#getconfig) | **GET** /system-config |
[**getDefaults**](SystemConfigApi.md#getdefaults) | **GET** /system-config/defaults |
[**getStorageTemplateOptions**](SystemConfigApi.md#getstoragetemplateoptions) | **GET** /system-config/storage-template-options |
[**updateConfig**](SystemConfigApi.md#updateconfig) | **PUT** /system-config |
@ -100,6 +101,49 @@ This endpoint does not need any parameter.
[[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)
# **getStorageTemplateOptions**
> SystemConfigTemplateStorageOptionDto getStorageTemplateOptions()
### Example
```dart
import 'package:openapi/api.dart';
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = SystemConfigApi();
try {
final result = api_instance.getStorageTemplateOptions();
print(result);
} catch (e) {
print('Exception when calling SystemConfigApi->getStorageTemplateOptions: $e\n');
}
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**SystemConfigTemplateStorageOptionDto**](SystemConfigTemplateStorageOptionDto.md)
### Authorization
[bearer](../README.md#bearer)
### HTTP request headers
- **Content-Type**: Not defined
- **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)
# **updateConfig**
> SystemConfigDto updateConfig(systemConfigDto)

View file

@ -10,6 +10,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ffmpeg** | [**SystemConfigFFmpegDto**](SystemConfigFFmpegDto.md) | |
**oauth** | [**SystemConfigOAuthDto**](SystemConfigOAuthDto.md) | |
**storageTemplate** | [**SystemConfigStorageTemplateDto**](SystemConfigStorageTemplateDto.md) | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,15 @@
# openapi.model.SystemConfigStorageTemplateDto
## Load the model package
```dart
import 'package:openapi/api.dart';
```
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**template** | **String** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -0,0 +1,21 @@
# openapi.model.SystemConfigTemplateStorageOptionDto
## Load the model package
```dart
import 'package:openapi/api.dart';
```
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**yearOptions** | **List<String>** | | [default to const []]
**monthOptions** | **List<String>** | | [default to const []]
**dayOptions** | **List<String>** | | [default to const []]
**hourOptions** | **List<String>** | | [default to const []]
**minuteOptions** | **List<String>** | | [default to const []]
**secondOptions** | **List<String>** | | [default to const []]
**presetOptions** | **List<String>** | | [default to const []]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View file

@ -91,6 +91,8 @@ part 'model/smart_info_response_dto.dart';
part 'model/system_config_dto.dart';
part 'model/system_config_f_fmpeg_dto.dart';
part 'model/system_config_o_auth_dto.dart';
part 'model/system_config_storage_template_dto.dart';
part 'model/system_config_template_storage_option_dto.dart';
part 'model/tag_response_dto.dart';
part 'model/tag_type_enum.dart';
part 'model/thumbnail_format.dart';

View file

@ -98,6 +98,47 @@ class SystemConfigApi {
return null;
}
/// Performs an HTTP 'GET /system-config/storage-template-options' operation and returns the [Response].
Future<Response> getStorageTemplateOptionsWithHttpInfo() async {
// ignore: prefer_const_declarations
final path = r'/system-config/storage-template-options';
// ignore: prefer_final_locals
Object? postBody;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
const contentTypes = <String>[];
return apiClient.invokeAPI(
path,
'GET',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
);
}
Future<SystemConfigTemplateStorageOptionDto?> getStorageTemplateOptions() async {
final response = await getStorageTemplateOptionsWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
// When a remote server returns no body with a status of 204, we shall not decode it.
// 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), 'SystemConfigTemplateStorageOptionDto',) as SystemConfigTemplateStorageOptionDto;
}
return null;
}
/// Performs an HTTP 'PUT /system-config' operation and returns the [Response].
/// Parameters:
///

View file

@ -298,6 +298,10 @@ class ApiClient {
return SystemConfigFFmpegDto.fromJson(value);
case 'SystemConfigOAuthDto':
return SystemConfigOAuthDto.fromJson(value);
case 'SystemConfigStorageTemplateDto':
return SystemConfigStorageTemplateDto.fromJson(value);
case 'SystemConfigTemplateStorageOptionDto':
return SystemConfigTemplateStorageOptionDto.fromJson(value);
case 'TagResponseDto':
return TagResponseDto.fromJson(value);
case 'TagTypeEnum':

View file

@ -15,30 +15,36 @@ class SystemConfigDto {
SystemConfigDto({
required this.ffmpeg,
required this.oauth,
required this.storageTemplate,
});
SystemConfigFFmpegDto ffmpeg;
SystemConfigOAuthDto oauth;
SystemConfigStorageTemplateDto storageTemplate;
@override
bool operator ==(Object other) => identical(this, other) || other is SystemConfigDto &&
other.ffmpeg == ffmpeg &&
other.oauth == oauth;
other.oauth == oauth &&
other.storageTemplate == storageTemplate;
@override
int get hashCode =>
// ignore: unnecessary_parenthesis
(ffmpeg.hashCode) +
(oauth.hashCode);
(oauth.hashCode) +
(storageTemplate.hashCode);
@override
String toString() => 'SystemConfigDto[ffmpeg=$ffmpeg, oauth=$oauth]';
String toString() => 'SystemConfigDto[ffmpeg=$ffmpeg, oauth=$oauth, storageTemplate=$storageTemplate]';
Map<String, dynamic> toJson() {
final _json = <String, dynamic>{};
_json[r'ffmpeg'] = ffmpeg;
_json[r'oauth'] = oauth;
_json[r'storageTemplate'] = storageTemplate;
return _json;
}
@ -63,6 +69,7 @@ class SystemConfigDto {
return SystemConfigDto(
ffmpeg: SystemConfigFFmpegDto.fromJson(json[r'ffmpeg'])!,
oauth: SystemConfigOAuthDto.fromJson(json[r'oauth'])!,
storageTemplate: SystemConfigStorageTemplateDto.fromJson(json[r'storageTemplate'])!,
);
}
return null;
@ -114,6 +121,7 @@ class SystemConfigDto {
static const requiredKeys = <String>{
'ffmpeg',
'oauth',
'storageTemplate',
};
}

View file

@ -0,0 +1,111 @@
//
// 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 SystemConfigStorageTemplateDto {
/// Returns a new [SystemConfigStorageTemplateDto] instance.
SystemConfigStorageTemplateDto({
required this.template,
});
String template;
@override
bool operator ==(Object other) => identical(this, other) || other is SystemConfigStorageTemplateDto &&
other.template == template;
@override
int get hashCode =>
// ignore: unnecessary_parenthesis
(template.hashCode);
@override
String toString() => 'SystemConfigStorageTemplateDto[template=$template]';
Map<String, dynamic> toJson() {
final _json = <String, dynamic>{};
_json[r'template'] = template;
return _json;
}
/// Returns a new [SystemConfigStorageTemplateDto] instance and imports its values from
/// [value] if it's a [Map], null otherwise.
// ignore: prefer_constructors_over_static_methods
static SystemConfigStorageTemplateDto? 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 "SystemConfigStorageTemplateDto[$key]" is missing from JSON.');
assert(json[key] != null, 'Required key "SystemConfigStorageTemplateDto[$key]" has a null value in JSON.');
});
return true;
}());
return SystemConfigStorageTemplateDto(
template: mapValueOfType<String>(json, r'template')!,
);
}
return null;
}
static List<SystemConfigStorageTemplateDto>? listFromJson(dynamic json, {bool growable = false,}) {
final result = <SystemConfigStorageTemplateDto>[];
if (json is List && json.isNotEmpty) {
for (final row in json) {
final value = SystemConfigStorageTemplateDto.fromJson(row);
if (value != null) {
result.add(value);
}
}
}
return result.toList(growable: growable);
}
static Map<String, SystemConfigStorageTemplateDto> mapFromJson(dynamic json) {
final map = <String, SystemConfigStorageTemplateDto>{};
if (json is Map && json.isNotEmpty) {
json = json.cast<String, dynamic>(); // ignore: parameter_assignments
for (final entry in json.entries) {
final value = SystemConfigStorageTemplateDto.fromJson(entry.value);
if (value != null) {
map[entry.key] = value;
}
}
}
return map;
}
// maps a json object with a list of SystemConfigStorageTemplateDto-objects as value to a dart map
static Map<String, List<SystemConfigStorageTemplateDto>> mapListFromJson(dynamic json, {bool growable = false,}) {
final map = <String, List<SystemConfigStorageTemplateDto>>{};
if (json is Map && json.isNotEmpty) {
json = json.cast<String, dynamic>(); // ignore: parameter_assignments
for (final entry in json.entries) {
final value = SystemConfigStorageTemplateDto.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>{
'template',
};
}

View file

@ -0,0 +1,173 @@
//
// 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 SystemConfigTemplateStorageOptionDto {
/// Returns a new [SystemConfigTemplateStorageOptionDto] instance.
SystemConfigTemplateStorageOptionDto({
this.yearOptions = const [],
this.monthOptions = const [],
this.dayOptions = const [],
this.hourOptions = const [],
this.minuteOptions = const [],
this.secondOptions = const [],
this.presetOptions = const [],
});
List<String> yearOptions;
List<String> monthOptions;
List<String> dayOptions;
List<String> hourOptions;
List<String> minuteOptions;
List<String> secondOptions;
List<String> presetOptions;
@override
bool operator ==(Object other) => identical(this, other) || other is SystemConfigTemplateStorageOptionDto &&
other.yearOptions == yearOptions &&
other.monthOptions == monthOptions &&
other.dayOptions == dayOptions &&
other.hourOptions == hourOptions &&
other.minuteOptions == minuteOptions &&
other.secondOptions == secondOptions &&
other.presetOptions == presetOptions;
@override
int get hashCode =>
// ignore: unnecessary_parenthesis
(yearOptions.hashCode) +
(monthOptions.hashCode) +
(dayOptions.hashCode) +
(hourOptions.hashCode) +
(minuteOptions.hashCode) +
(secondOptions.hashCode) +
(presetOptions.hashCode);
@override
String toString() => 'SystemConfigTemplateStorageOptionDto[yearOptions=$yearOptions, monthOptions=$monthOptions, dayOptions=$dayOptions, hourOptions=$hourOptions, minuteOptions=$minuteOptions, secondOptions=$secondOptions, presetOptions=$presetOptions]';
Map<String, dynamic> toJson() {
final _json = <String, dynamic>{};
_json[r'yearOptions'] = yearOptions;
_json[r'monthOptions'] = monthOptions;
_json[r'dayOptions'] = dayOptions;
_json[r'hourOptions'] = hourOptions;
_json[r'minuteOptions'] = minuteOptions;
_json[r'secondOptions'] = secondOptions;
_json[r'presetOptions'] = presetOptions;
return _json;
}
/// Returns a new [SystemConfigTemplateStorageOptionDto] instance and imports its values from
/// [value] if it's a [Map], null otherwise.
// ignore: prefer_constructors_over_static_methods
static SystemConfigTemplateStorageOptionDto? 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 "SystemConfigTemplateStorageOptionDto[$key]" is missing from JSON.');
assert(json[key] != null, 'Required key "SystemConfigTemplateStorageOptionDto[$key]" has a null value in JSON.');
});
return true;
}());
return SystemConfigTemplateStorageOptionDto(
yearOptions: json[r'yearOptions'] is List
? (json[r'yearOptions'] as List).cast<String>()
: const [],
monthOptions: json[r'monthOptions'] is List
? (json[r'monthOptions'] as List).cast<String>()
: const [],
dayOptions: json[r'dayOptions'] is List
? (json[r'dayOptions'] as List).cast<String>()
: const [],
hourOptions: json[r'hourOptions'] is List
? (json[r'hourOptions'] as List).cast<String>()
: const [],
minuteOptions: json[r'minuteOptions'] is List
? (json[r'minuteOptions'] as List).cast<String>()
: const [],
secondOptions: json[r'secondOptions'] is List
? (json[r'secondOptions'] as List).cast<String>()
: const [],
presetOptions: json[r'presetOptions'] is List
? (json[r'presetOptions'] as List).cast<String>()
: const [],
);
}
return null;
}
static List<SystemConfigTemplateStorageOptionDto>? listFromJson(dynamic json, {bool growable = false,}) {
final result = <SystemConfigTemplateStorageOptionDto>[];
if (json is List && json.isNotEmpty) {
for (final row in json) {
final value = SystemConfigTemplateStorageOptionDto.fromJson(row);
if (value != null) {
result.add(value);
}
}
}
return result.toList(growable: growable);
}
static Map<String, SystemConfigTemplateStorageOptionDto> mapFromJson(dynamic json) {
final map = <String, SystemConfigTemplateStorageOptionDto>{};
if (json is Map && json.isNotEmpty) {
json = json.cast<String, dynamic>(); // ignore: parameter_assignments
for (final entry in json.entries) {
final value = SystemConfigTemplateStorageOptionDto.fromJson(entry.value);
if (value != null) {
map[entry.key] = value;
}
}
}
return map;
}
// maps a json object with a list of SystemConfigTemplateStorageOptionDto-objects as value to a dart map
static Map<String, List<SystemConfigTemplateStorageOptionDto>> mapListFromJson(dynamic json, {bool growable = false,}) {
final map = <String, List<SystemConfigTemplateStorageOptionDto>>{};
if (json is Map && json.isNotEmpty) {
json = json.cast<String, dynamic>(); // ignore: parameter_assignments
for (final entry in json.entries) {
final value = SystemConfigTemplateStorageOptionDto.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>{
'yearOptions',
'monthOptions',
'dayOptions',
'hourOptions',
'minuteOptions',
'secondOptions',
'presetOptions',
};
}

View file

@ -27,6 +27,11 @@ void main() {
// TODO
});
//Future<SystemConfigTemplateStorageOptionDto> getStorageTemplateOptions() async
test('test getStorageTemplateOptions', () async {
// TODO
});
//Future<SystemConfigDto> updateConfig(SystemConfigDto systemConfigDto) async
test('test updateConfig', () async {
// TODO

View file

@ -26,6 +26,11 @@ void main() {
// TODO
});
// SystemConfigStorageTemplateDto storageTemplate
test('to test the property `storageTemplate`', () async {
// TODO
});
});

View file

@ -0,0 +1,27 @@
//
// 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 SystemConfigStorageTemplateDto
void main() {
// final instance = SystemConfigStorageTemplateDto();
group('test SystemConfigStorageTemplateDto', () {
// String template
test('to test the property `template`', () async {
// TODO
});
});
}

View file

@ -0,0 +1,57 @@
//
// 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 SystemConfigTemplateStorageOptionDto
void main() {
// final instance = SystemConfigTemplateStorageOptionDto();
group('test SystemConfigTemplateStorageOptionDto', () {
// List<String> yearOptions (default value: const [])
test('to test the property `yearOptions`', () async {
// TODO
});
// List<String> monthOptions (default value: const [])
test('to test the property `monthOptions`', () async {
// TODO
});
// List<String> dayOptions (default value: const [])
test('to test the property `dayOptions`', () async {
// TODO
});
// List<String> hourOptions (default value: const [])
test('to test the property `hourOptions`', () async {
// TODO
});
// List<String> minuteOptions (default value: const [])
test('to test the property `minuteOptions`', () async {
// TODO
});
// List<String> secondOptions (default value: const [])
test('to test the property `secondOptions`', () async {
// TODO
});
// List<String> presetOptions (default value: const [])
test('to test the property `presetOptions`', () async {
// TODO
});
});
}