mirror of
https://github.com/KevinMidboe/immich.git
synced 2026-01-16 14:16:03 +00:00
refactor(server): tags (#2589)
* refactor: tags * chore: open api * chore: unused import * feat: add/remove/get tag assets * chore: open api * chore: finish tag tests for add/remove assets
This commit is contained in:
Jason Rasmussen
GitHub
15
mobile/openapi/doc/AssetIdsDto.md
generated
Normal file
15
mobile/openapi/doc/AssetIdsDto.md
generated
Normal file
@@ -0,0 +1,15 @@
|
||||
# openapi.model.AssetIdsDto
|
||||
|
||||
## 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)
|
||||
|
||||
|
||||
17
mobile/openapi/doc/AssetIdsResponseDto.md
generated
Normal file
17
mobile/openapi/doc/AssetIdsResponseDto.md
generated
Normal file
@@ -0,0 +1,17 @@
|
||||
# openapi.model.AssetIdsResponseDto
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**assetId** | **String** | |
|
||||
**success** | **bool** | |
|
||||
**error** | **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)
|
||||
|
||||
|
||||
222
mobile/openapi/doc/TagApi.md
generated
222
mobile/openapi/doc/TagApi.md
generated
@@ -9,15 +9,18 @@ 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} |
|
||||
[**createTag**](TagApi.md#createtag) | **POST** /tag |
|
||||
[**deleteTag**](TagApi.md#deletetag) | **DELETE** /tag/{id} |
|
||||
[**getAllTags**](TagApi.md#getalltags) | **GET** /tag |
|
||||
[**getTagAssets**](TagApi.md#gettagassets) | **GET** /tag/{id}/assets |
|
||||
[**getTagById**](TagApi.md#gettagbyid) | **GET** /tag/{id} |
|
||||
[**tagAssets**](TagApi.md#tagassets) | **PUT** /tag/{id}/assets |
|
||||
[**untagAssets**](TagApi.md#untagassets) | **DELETE** /tag/{id}/assets |
|
||||
[**updateTag**](TagApi.md#updatetag) | **PATCH** /tag/{id} |
|
||||
|
||||
|
||||
# **create**
|
||||
> TagResponseDto create(createTagDto)
|
||||
# **createTag**
|
||||
> TagResponseDto createTag(createTagDto)
|
||||
|
||||
|
||||
|
||||
@@ -43,10 +46,10 @@ final api_instance = TagApi();
|
||||
final createTagDto = CreateTagDto(); // CreateTagDto |
|
||||
|
||||
try {
|
||||
final result = api_instance.create(createTagDto);
|
||||
final result = api_instance.createTag(createTagDto);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling TagApi->create: $e\n');
|
||||
print('Exception when calling TagApi->createTag: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
@@ -71,8 +74,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)
|
||||
|
||||
# **delete**
|
||||
> delete(id)
|
||||
# **deleteTag**
|
||||
> deleteTag(id)
|
||||
|
||||
|
||||
|
||||
@@ -98,9 +101,9 @@ final api_instance = TagApi();
|
||||
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
|
||||
|
||||
try {
|
||||
api_instance.delete(id);
|
||||
api_instance.deleteTag(id);
|
||||
} catch (e) {
|
||||
print('Exception when calling TagApi->delete: $e\n');
|
||||
print('Exception when calling TagApi->deleteTag: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
@@ -125,8 +128,8 @@ void (empty response body)
|
||||
|
||||
[[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<TagResponseDto> findAll()
|
||||
# **getAllTags**
|
||||
> List<TagResponseDto> getAllTags()
|
||||
|
||||
|
||||
|
||||
@@ -151,10 +154,10 @@ import 'package:openapi/api.dart';
|
||||
final api_instance = TagApi();
|
||||
|
||||
try {
|
||||
final result = api_instance.findAll();
|
||||
final result = api_instance.getAllTags();
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling TagApi->findAll: $e\n');
|
||||
print('Exception when calling TagApi->getAllTags: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
@@ -176,8 +179,8 @@ 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)
|
||||
|
||||
# **findOne**
|
||||
> TagResponseDto findOne(id)
|
||||
# **getTagAssets**
|
||||
> List<AssetResponseDto> getTagAssets(id)
|
||||
|
||||
|
||||
|
||||
@@ -203,10 +206,65 @@ final api_instance = TagApi();
|
||||
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
|
||||
|
||||
try {
|
||||
final result = api_instance.findOne(id);
|
||||
final result = api_instance.getTagAssets(id);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling TagApi->findOne: $e\n');
|
||||
print('Exception when calling TagApi->getTagAssets: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **String**| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**List<AssetResponseDto>**](AssetResponseDto.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [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)
|
||||
|
||||
# **getTagById**
|
||||
> TagResponseDto getTagById(id)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure API key authorization: cookie
|
||||
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
|
||||
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
|
||||
// TODO Configure API key authorization: api_key
|
||||
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
|
||||
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
|
||||
// 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 = TagApi();
|
||||
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
|
||||
|
||||
try {
|
||||
final result = api_instance.getTagById(id);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling TagApi->getTagById: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
@@ -231,8 +289,122 @@ 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)
|
||||
|
||||
# **update**
|
||||
> TagResponseDto update(id, updateTagDto)
|
||||
# **tagAssets**
|
||||
> List<AssetIdsResponseDto> tagAssets(id, assetIdsDto)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure API key authorization: cookie
|
||||
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
|
||||
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
|
||||
// TODO Configure API key authorization: api_key
|
||||
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
|
||||
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
|
||||
// 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 = TagApi();
|
||||
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
|
||||
final assetIdsDto = AssetIdsDto(); // AssetIdsDto |
|
||||
|
||||
try {
|
||||
final result = api_instance.tagAssets(id, assetIdsDto);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling TagApi->tagAssets: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **String**| |
|
||||
**assetIdsDto** | [**AssetIdsDto**](AssetIdsDto.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**List<AssetIdsResponseDto>**](AssetIdsResponseDto.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [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)
|
||||
|
||||
# **untagAssets**
|
||||
> List<AssetIdsResponseDto> untagAssets(id, assetIdsDto)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure API key authorization: cookie
|
||||
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
|
||||
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
|
||||
// TODO Configure API key authorization: api_key
|
||||
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
|
||||
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
|
||||
// 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 = TagApi();
|
||||
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
|
||||
final assetIdsDto = AssetIdsDto(); // AssetIdsDto |
|
||||
|
||||
try {
|
||||
final result = api_instance.untagAssets(id, assetIdsDto);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling TagApi->untagAssets: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **String**| |
|
||||
**assetIdsDto** | [**AssetIdsDto**](AssetIdsDto.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**List<AssetIdsResponseDto>**](AssetIdsResponseDto.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [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)
|
||||
|
||||
# **updateTag**
|
||||
> TagResponseDto updateTag(id, updateTagDto)
|
||||
|
||||
|
||||
|
||||
@@ -259,10 +431,10 @@ final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
|
||||
final updateTagDto = UpdateTagDto(); // UpdateTagDto |
|
||||
|
||||
try {
|
||||
final result = api_instance.update(id, updateTagDto);
|
||||
final result = api_instance.updateTag(id, updateTagDto);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling TagApi->update: $e\n');
|
||||
print('Exception when calling TagApi->updateTag: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
3
mobile/openapi/doc/TagResponseDto.md
generated
3
mobile/openapi/doc/TagResponseDto.md
generated
@@ -8,11 +8,10 @@ import 'package:openapi/api.dart';
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **String** | |
|
||||
**type** | [**TagTypeEnum**](TagTypeEnum.md) | |
|
||||
**id** | **String** | |
|
||||
**name** | **String** | |
|
||||
**userId** | **String** | |
|
||||
**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)
|
||||
|
||||
|
||||
1
mobile/openapi/doc/UpdateTagDto.md
generated
1
mobile/openapi/doc/UpdateTagDto.md
generated
@@ -9,7 +9,6 @@ import 'package:openapi/api.dart';
|
||||
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)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user