mirror of
https://github.com/KevinMidboe/immich.git
synced 2026-01-10 03:05:50 +00:00
feat(server) Tagging system (#1046)
This commit is contained in:
10
mobile/openapi/doc/AssetApi.md
generated
10
mobile/openapi/doc/AssetApi.md
generated
@@ -26,7 +26,7 @@ Method | HTTP request | Description
|
||||
[**getUserAssetsByDeviceId**](AssetApi.md#getuserassetsbydeviceid) | **GET** /asset/{deviceId} |
|
||||
[**searchAsset**](AssetApi.md#searchasset) | **POST** /asset/search |
|
||||
[**serveFile**](AssetApi.md#servefile) | **GET** /asset/file/{assetId} |
|
||||
[**updateAssetById**](AssetApi.md#updateassetbyid) | **PUT** /asset/assetById/{assetId} |
|
||||
[**updateAsset**](AssetApi.md#updateasset) | **PUT** /asset/{assetId} |
|
||||
[**uploadFile**](AssetApi.md#uploadfile) | **POST** /asset/upload |
|
||||
|
||||
|
||||
@@ -833,8 +833,8 @@ 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)
|
||||
|
||||
# **updateAssetById**
|
||||
> AssetResponseDto updateAssetById(assetId, updateAssetDto)
|
||||
# **updateAsset**
|
||||
> AssetResponseDto updateAsset(assetId, updateAssetDto)
|
||||
|
||||
|
||||
|
||||
@@ -855,10 +855,10 @@ final assetId = assetId_example; // String |
|
||||
final updateAssetDto = UpdateAssetDto(); // UpdateAssetDto |
|
||||
|
||||
try {
|
||||
final result = api_instance.updateAssetById(assetId, updateAssetDto);
|
||||
final result = api_instance.updateAsset(assetId, updateAssetDto);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling AssetApi->updateAssetById: $e\n');
|
||||
print('Exception when calling AssetApi->updateAsset: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
34
mobile/openapi/doc/AssetEntity.md
generated
Normal file
34
mobile/openapi/doc/AssetEntity.md
generated
Normal file
@@ -0,0 +1,34 @@
|
||||
# openapi.model.AssetEntity
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **String** | |
|
||||
**deviceAssetId** | **String** | |
|
||||
**userId** | **String** | |
|
||||
**deviceId** | **String** | |
|
||||
**type** | **String** | |
|
||||
**originalPath** | **String** | |
|
||||
**resizePath** | **String** | |
|
||||
**webpPath** | **String** | |
|
||||
**encodedVideoPath** | **String** | |
|
||||
**createdAt** | **String** | |
|
||||
**modifiedAt** | **String** | |
|
||||
**isFavorite** | **bool** | |
|
||||
**mimeType** | **String** | |
|
||||
**checksum** | [**Object**](.md) | | [optional]
|
||||
**duration** | **String** | |
|
||||
**isVisible** | **bool** | |
|
||||
**livePhotoVideoId** | **String** | |
|
||||
**exifInfo** | [**ExifEntity**](ExifEntity.md) | | [optional]
|
||||
**smartInfo** | [**SmartInfoEntity**](SmartInfoEntity.md) | | [optional]
|
||||
**tags** | [**List<TagEntity>**](TagEntity.md) | | [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)
|
||||
|
||||
|
||||
1
mobile/openapi/doc/AssetResponseDto.md
generated
1
mobile/openapi/doc/AssetResponseDto.md
generated
@@ -25,6 +25,7 @@ Name | Type | Description | Notes
|
||||
**exifInfo** | [**ExifResponseDto**](ExifResponseDto.md) | | [optional]
|
||||
**smartInfo** | [**SmartInfoResponseDto**](SmartInfoResponseDto.md) | | [optional]
|
||||
**livePhotoVideoId** | **String** | | [optional]
|
||||
**tags** | [**List<TagResponseDto>**](TagResponseDto.md) | | [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)
|
||||
|
||||
|
||||
16
mobile/openapi/doc/CreateTagDto.md
generated
Normal file
16
mobile/openapi/doc/CreateTagDto.md
generated
Normal file
@@ -0,0 +1,16 @@
|
||||
# openapi.model.CreateTagDto
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | [**TagTypeEnum**](TagTypeEnum.md) | |
|
||||
**name** | **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)
|
||||
|
||||
|
||||
39
mobile/openapi/doc/ExifEntity.md
generated
Normal file
39
mobile/openapi/doc/ExifEntity.md
generated
Normal file
@@ -0,0 +1,39 @@
|
||||
# openapi.model.ExifEntity
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **String** | |
|
||||
**assetId** | **String** | |
|
||||
**description** | **String** | General info |
|
||||
**exifImageWidth** | **num** | |
|
||||
**exifImageHeight** | **num** | |
|
||||
**fileSizeInByte** | **num** | |
|
||||
**orientation** | **String** | |
|
||||
**dateTimeOriginal** | [**DateTime**](DateTime.md) | |
|
||||
**modifyDate** | [**DateTime**](DateTime.md) | |
|
||||
**latitude** | **num** | |
|
||||
**longitude** | **num** | |
|
||||
**city** | **String** | |
|
||||
**state** | **String** | |
|
||||
**country** | **String** | |
|
||||
**make** | **String** | Image info |
|
||||
**model** | **String** | |
|
||||
**imageName** | **String** | |
|
||||
**lensModel** | **String** | |
|
||||
**fNumber** | **num** | |
|
||||
**focalLength** | **num** | |
|
||||
**iso** | **num** | |
|
||||
**exposureTime** | **num** | |
|
||||
**fps** | **num** | Video info | [optional]
|
||||
**asset** | [**AssetEntity**](AssetEntity.md) | | [optional]
|
||||
**exifTextSearchableColumn** | **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)
|
||||
|
||||
|
||||
19
mobile/openapi/doc/SmartInfoEntity.md
generated
Normal file
19
mobile/openapi/doc/SmartInfoEntity.md
generated
Normal file
@@ -0,0 +1,19 @@
|
||||
# openapi.model.SmartInfoEntity
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **String** | |
|
||||
**assetId** | **String** | |
|
||||
**tags** | **List<String>** | | [default to const []]
|
||||
**objects** | **List<String>** | | [default to const []]
|
||||
**asset** | [**AssetEntity**](AssetEntity.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)
|
||||
|
||||
|
||||
221
mobile/openapi/doc/TagApi.md
generated
Normal file
221
mobile/openapi/doc/TagApi.md
generated
Normal file
@@ -0,0 +1,221 @@
|
||||
# openapi.api.TagApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to */api*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create**](TagApi.md#create) | **POST** /tag |
|
||||
[**delete**](TagApi.md#delete) | **DELETE** /tag/{id} |
|
||||
[**findAll**](TagApi.md#findall) | **GET** /tag |
|
||||
[**findOne**](TagApi.md#findone) | **GET** /tag/{id} |
|
||||
[**update**](TagApi.md#update) | **PATCH** /tag/{id} |
|
||||
|
||||
|
||||
# **create**
|
||||
> TagEntity create(createTagDto)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
|
||||
final api_instance = TagApi();
|
||||
final createTagDto = CreateTagDto(); // CreateTagDto |
|
||||
|
||||
try {
|
||||
final result = api_instance.create(createTagDto);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling TagApi->create: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**createTagDto** | [**CreateTagDto**](CreateTagDto.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**TagEntity**](TagEntity.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)
|
||||
|
||||
# **delete**
|
||||
> TagEntity delete(id)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
|
||||
final api_instance = TagApi();
|
||||
final id = id_example; // String |
|
||||
|
||||
try {
|
||||
final result = api_instance.delete(id);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling TagApi->delete: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **String**| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**TagEntity**](TagEntity.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)
|
||||
|
||||
# **findAll**
|
||||
> List<TagEntity> findAll()
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
|
||||
final api_instance = TagApi();
|
||||
|
||||
try {
|
||||
final result = api_instance.findAll();
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling TagApi->findAll: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**List<TagEntity>**](TagEntity.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)
|
||||
|
||||
# **findOne**
|
||||
> TagEntity findOne(id)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
|
||||
final api_instance = TagApi();
|
||||
final id = id_example; // String |
|
||||
|
||||
try {
|
||||
final result = api_instance.findOne(id);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling TagApi->findOne: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **String**| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**TagEntity**](TagEntity.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)
|
||||
|
||||
# **update**
|
||||
> Object update(id, updateTagDto)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
|
||||
final api_instance = TagApi();
|
||||
final id = id_example; // String |
|
||||
final updateTagDto = UpdateTagDto(); // UpdateTagDto |
|
||||
|
||||
try {
|
||||
final result = api_instance.update(id, updateTagDto);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling TagApi->update: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **String**| |
|
||||
**updateTagDto** | [**UpdateTagDto**](UpdateTagDto.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Object**](Object.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)
|
||||
|
||||
21
mobile/openapi/doc/TagEntity.md
generated
Normal file
21
mobile/openapi/doc/TagEntity.md
generated
Normal file
@@ -0,0 +1,21 @@
|
||||
# openapi.model.TagEntity
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **String** | |
|
||||
**type** | **String** | |
|
||||
**name** | **String** | |
|
||||
**userId** | **String** | |
|
||||
**renameTagId** | **String** | |
|
||||
**assets** | [**List<AssetEntity>**](AssetEntity.md) | | [default to const []]
|
||||
**user** | [**UserEntity**](UserEntity.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)
|
||||
|
||||
|
||||
17
mobile/openapi/doc/TagResponseDto.md
generated
Normal file
17
mobile/openapi/doc/TagResponseDto.md
generated
Normal file
@@ -0,0 +1,17 @@
|
||||
# openapi.model.TagResponseDto
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **String** | |
|
||||
**type** | [**TagTypeEnum**](TagTypeEnum.md) | |
|
||||
**name** | **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)
|
||||
|
||||
|
||||
14
mobile/openapi/doc/TagTypeEnum.md
generated
Normal file
14
mobile/openapi/doc/TagTypeEnum.md
generated
Normal file
@@ -0,0 +1,14 @@
|
||||
# openapi.model.TagTypeEnum
|
||||
|
||||
## 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)
|
||||
|
||||
|
||||
3
mobile/openapi/doc/UpdateAssetDto.md
generated
3
mobile/openapi/doc/UpdateAssetDto.md
generated
@@ -8,7 +8,8 @@ import 'package:openapi/api.dart';
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**isFavorite** | **bool** | |
|
||||
**tagIds** | **List<String>** | | [optional] [default to const []]
|
||||
**isFavorite** | **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)
|
||||
|
||||
|
||||
16
mobile/openapi/doc/UpdateTagDto.md
generated
Normal file
16
mobile/openapi/doc/UpdateTagDto.md
generated
Normal file
@@ -0,0 +1,16 @@
|
||||
# openapi.model.UpdateTagDto
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **String** | | [optional]
|
||||
**renameTagId** | **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)
|
||||
|
||||
|
||||
27
mobile/openapi/doc/UserEntity.md
generated
Normal file
27
mobile/openapi/doc/UserEntity.md
generated
Normal file
@@ -0,0 +1,27 @@
|
||||
# openapi.model.UserEntity
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **String** | |
|
||||
**firstName** | **String** | |
|
||||
**lastName** | **String** | |
|
||||
**isAdmin** | **bool** | |
|
||||
**email** | **String** | |
|
||||
**password** | **String** | | [optional]
|
||||
**salt** | **String** | | [optional]
|
||||
**oauthId** | **String** | |
|
||||
**profileImagePath** | **String** | |
|
||||
**shouldChangePassword** | **bool** | |
|
||||
**createdAt** | **String** | |
|
||||
**deletedAt** | [**DateTime**](DateTime.md) | | [optional]
|
||||
**tags** | [**List<TagEntity>**](TagEntity.md) | | [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)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user