feat(web/server) public album sharing (#1266)

2026-01-18 07:06:46 +00:00 · 2023-01-09 14:16:08 -06:00
parent fd15cdbf40
commit 10789503c1
101 changed files with 4879 additions and 347 deletions
--- a/mobile/openapi/doc/AlbumApi.md
+++ b/mobile/openapi/doc/AlbumApi.md
@@ -12,6 +12,7 @@ Method | HTTP request | Description
 [**addAssetsToAlbum**](AlbumApi.md#addassetstoalbum) | **PUT** /album/{albumId}/assets | 
 [**addUsersToAlbum**](AlbumApi.md#adduserstoalbum) | **PUT** /album/{albumId}/users | 
 [**createAlbum**](AlbumApi.md#createalbum) | **POST** /album | 
+[**createAlbumSharedLink**](AlbumApi.md#createalbumsharedlink) | **POST** /album/create-shared-link | 
 [**deleteAlbum**](AlbumApi.md#deletealbum) | **DELETE** /album/{albumId} | 
 [**downloadArchive**](AlbumApi.md#downloadarchive) | **GET** /album/{albumId}/download | 
 [**getAlbumCountByUserId**](AlbumApi.md#getalbumcountbyuserid) | **GET** /album/count-by-user-id | 
@@ -167,6 +168,53 @@ Name | Type | Description  | Notes

 [[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)

+# **createAlbumSharedLink**
+> SharedLinkResponseDto createAlbumSharedLink(createAlbumShareLinkDto)
+
+
+
+### 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 = AlbumApi();
+final createAlbumShareLinkDto = CreateAlbumShareLinkDto(); // CreateAlbumShareLinkDto | 
+
+try {
+    final result = api_instance.createAlbumSharedLink(createAlbumShareLinkDto);
+    print(result);
+} catch (e) {
+    print('Exception when calling AlbumApi->createAlbumSharedLink: $e\n');
+}
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **createAlbumShareLinkDto** | [**CreateAlbumShareLinkDto**](CreateAlbumShareLinkDto.md)|  | 
+
+### Return type
+
+[**SharedLinkResponseDto**](SharedLinkResponseDto.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **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)
+
 # **deleteAlbum**
 > deleteAlbum(albumId)

--- a/mobile/openapi/doc/AssetApi.md
+++ b/mobile/openapi/doc/AssetApi.md
@@ -13,6 +13,7 @@ Method | HTTP request | Description
 [**checkExistingAssets**](AssetApi.md#checkexistingassets) | **POST** /asset/exist | 
 [**deleteAsset**](AssetApi.md#deleteasset) | **DELETE** /asset | 
 [**downloadFile**](AssetApi.md#downloadfile) | **GET** /asset/download/{assetId} | 
+[**downloadFiles**](AssetApi.md#downloadfiles) | **POST** /asset/download-files | 
 [**downloadLibrary**](AssetApi.md#downloadlibrary) | **GET** /asset/download-library | 
 [**getAllAssets**](AssetApi.md#getallassets) | **GET** /asset | 
 [**getAssetById**](AssetApi.md#getassetbyid) | **GET** /asset/assetById/{assetId} | 
@@ -226,6 +227,53 @@ Name | Type | Description  | Notes

 [[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)

+# **downloadFiles**
+> Object downloadFiles(downloadFilesDto)
+
+
+
+### 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 = AssetApi();
+final downloadFilesDto = DownloadFilesDto(); // DownloadFilesDto | 
+
+try {
+    final result = api_instance.downloadFiles(downloadFilesDto);
+    print(result);
+} catch (e) {
+    print('Exception when calling AssetApi->downloadFiles: $e\n');
+}
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **downloadFilesDto** | [**DownloadFilesDto**](DownloadFilesDto.md)|  | 
+
+### Return type
+
+[**Object**](Object.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **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)
+
 # **downloadLibrary**
 > Object downloadLibrary(skip)

--- a/mobile/openapi/doc/CreateAlbumShareLinkDto.md
+++ b/mobile/openapi/doc/CreateAlbumShareLinkDto.md
@@ -0,0 +1,18 @@
+# openapi.model.CreateAlbumShareLinkDto
+
+## Load the model package
+```dart
+import 'package:openapi/api.dart';
+```
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**albumId** | **String** |  | 
+**expiredAt** | **String** |  | [optional] 
+**allowUpload** | **bool** |  | [optional] 
+**description** | **String** |  | [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)
+
+
--- a/mobile/openapi/doc/DownloadFilesDto.md
+++ b/mobile/openapi/doc/DownloadFilesDto.md
@@ -0,0 +1,15 @@
+# openapi.model.DownloadFilesDto
+
+## Load the model package
+```dart
+import 'package:openapi/api.dart';
+```
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**assetIds** | **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)
+
+
--- a/mobile/openapi/doc/EditSharedLinkDto.md
+++ b/mobile/openapi/doc/EditSharedLinkDto.md
@@ -0,0 +1,18 @@
+# openapi.model.EditSharedLinkDto
+
+## Load the model package
+```dart
+import 'package:openapi/api.dart';
+```
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** |  | [optional] 
+**expiredAt** | **String** |  | [optional] 
+**allowUpload** | **bool** |  | [optional] 
+**isEditExpireTime** | **bool** |  | [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)
+
+
--- a/mobile/openapi/doc/ShareApi.md
+++ b/mobile/openapi/doc/ShareApi.md
@@ -0,0 +1,217 @@
+# openapi.api.ShareApi
+
+## Load the API package
+```dart
+import 'package:openapi/api.dart';
+```
+
+All URIs are relative to */api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**editSharedLink**](ShareApi.md#editsharedlink) | **PATCH** /share/{id} | 
+[**getAllSharedLinks**](ShareApi.md#getallsharedlinks) | **GET** /share | 
+[**getMySharedLink**](ShareApi.md#getmysharedlink) | **GET** /share/me | 
+[**getSharedLinkById**](ShareApi.md#getsharedlinkbyid) | **GET** /share/{id} | 
+[**removeSharedLink**](ShareApi.md#removesharedlink) | **DELETE** /share/{id} | 
+
+
+# **editSharedLink**
+> SharedLinkResponseDto editSharedLink(id, editSharedLinkDto)
+
+
+
+### Example
+```dart
+import 'package:openapi/api.dart';
+
+final api_instance = ShareApi();
+final id = id_example; // String | 
+final editSharedLinkDto = EditSharedLinkDto(); // EditSharedLinkDto | 
+
+try {
+    final result = api_instance.editSharedLink(id, editSharedLinkDto);
+    print(result);
+} catch (e) {
+    print('Exception when calling ShareApi->editSharedLink: $e\n');
+}
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **editSharedLinkDto** | [**EditSharedLinkDto**](EditSharedLinkDto.md)|  | 
+
+### Return type
+
+[**SharedLinkResponseDto**](SharedLinkResponseDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **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)
+
+# **getAllSharedLinks**
+> List<SharedLinkResponseDto> getAllSharedLinks()
+
+
+
+### Example
+```dart
+import 'package:openapi/api.dart';
+
+final api_instance = ShareApi();
+
+try {
+    final result = api_instance.getAllSharedLinks();
+    print(result);
+} catch (e) {
+    print('Exception when calling ShareApi->getAllSharedLinks: $e\n');
+}
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**List<SharedLinkResponseDto>**](SharedLinkResponseDto.md)
+
+### Authorization
+
+No authorization required
+
+### 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)
+
+# **getMySharedLink**
+> SharedLinkResponseDto getMySharedLink()
+
+
+
+### Example
+```dart
+import 'package:openapi/api.dart';
+
+final api_instance = ShareApi();
+
+try {
+    final result = api_instance.getMySharedLink();
+    print(result);
+} catch (e) {
+    print('Exception when calling ShareApi->getMySharedLink: $e\n');
+}
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**SharedLinkResponseDto**](SharedLinkResponseDto.md)
+
+### Authorization
+
+No authorization required
+
+### 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)
+
+# **getSharedLinkById**
+> SharedLinkResponseDto getSharedLinkById(id)
+
+
+
+### Example
+```dart
+import 'package:openapi/api.dart';
+
+final api_instance = ShareApi();
+final id = id_example; // String | 
+
+try {
+    final result = api_instance.getSharedLinkById(id);
+    print(result);
+} catch (e) {
+    print('Exception when calling ShareApi->getSharedLinkById: $e\n');
+}
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+
+### Return type
+
+[**SharedLinkResponseDto**](SharedLinkResponseDto.md)
+
+### Authorization
+
+No authorization required
+
+### 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)
+
+# **removeSharedLink**
+> String removeSharedLink(id)
+
+
+
+### Example
+```dart
+import 'package:openapi/api.dart';
+
+final api_instance = ShareApi();
+final id = id_example; // String | 
+
+try {
+    final result = api_instance.removeSharedLink(id);
+    print(result);
+} catch (e) {
+    print('Exception when calling ShareApi->removeSharedLink: $e\n');
+}
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### 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)
+
--- a/mobile/openapi/doc/SharedLinkResponseDto.md
+++ b/mobile/openapi/doc/SharedLinkResponseDto.md
@@ -0,0 +1,24 @@
+# openapi.model.SharedLinkResponseDto
+
+## Load the model package
+```dart
+import 'package:openapi/api.dart';
+```
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | [**SharedLinkType**](SharedLinkType.md) |  | 
+**id** | **String** |  | 
+**description** | **String** |  | [optional] 
+**userId** | **String** |  | 
+**key** | **String** |  | 
+**createdAt** | **String** |  | 
+**expiresAt** | **String** |  | 
+**assets** | **List<String>** |  | [default to const []]
+**album** | [**AlbumResponseDto**](AlbumResponseDto.md) |  | [optional] 
+**allowUpload** | **bool** |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
--- a/mobile/openapi/doc/SharedLinkType.md
+++ b/mobile/openapi/doc/SharedLinkType.md
@@ -0,0 +1,14 @@
+# openapi.model.SharedLinkType
+
+## Load the model package
+```dart
+import 'package:openapi/api.dart';
+```
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+