KevinMidboe/immich
1
0
Fork 0
mirror of https://github.com/KevinMidboe/immich.git synced 2025-10-29 17:40:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fixed openapi generation command for mobile

Browse Source
This commit is contained in:
Alex Tran
2022-12-06 16:10:04 -06:00
parent f91bdc2785
commit b5a5363a6a
82 changed files with 363 additions and 4231 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
mobile/openapi/doc/AdminConfigResponseDto.md generated
View File

@@ -1,15 +0,0 @@
# openapi.model.AdminConfigResponseDto
## Load the model package
```dart
import 'package:openapi/api.dart';
```
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**config** | [**Object**](.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)

16
mobile/openapi/doc/AssetCountByTimeGroupDto.md generated
View File

@@ -1,16 +0,0 @@
# openapi.model.AssetCountByTimeGroupDto
## Load the model package
```dart
import 'package:openapi/api.dart';
```
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**timeGroup** | **String** | |
**count** | **int** | |
[[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/AssetCountByTimeGroupResponseDto.md generated
View File

@@ -1,16 +0,0 @@
# openapi.model.AssetCountByTimeGroupResponseDto
## Load the model package
```dart
import 'package:openapi/api.dart';
```
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**count** | **int** | |
**buckets** | [**List<AssetCountByTimeBucketResponseDto>**](AssetCountByTimeBucketResponseDto.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/AssetCountResponseDto.md generated
View File

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

34
mobile/openapi/doc/AssetEntity.md generated
View File

@@ -1,34 +0,0 @@
# 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)

105
mobile/openapi/doc/ConfigApi.md generated
View File

@@ -1,105 +0,0 @@
# openapi.api.ConfigApi
## Load the API package
```dart
import 'package:openapi/api.dart';
```
All URIs are relative to */api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**getSystemConfig**](ConfigApi.md#getsystemconfig) | **GET** /config/system |
[**updateSystemConfig**](ConfigApi.md#updatesystemconfig) | **PUT** /config/system |
# **getSystemConfig**
> SystemConfigResponseDto getSystemConfig()
### 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 = ConfigApi();
try {
final result = api_instance.getSystemConfig();
print(result);
} catch (e) {
print('Exception when calling ConfigApi->getSystemConfig: $e\n');
}
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**SystemConfigResponseDto**](SystemConfigResponseDto.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)
# **updateSystemConfig**
> SystemConfigResponseDto updateSystemConfig(body)
### 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 = ConfigApi();
final body = Object(); // Object |
try {
final result = api_instance.updateSystemConfig(body);
print(result);
} catch (e) {
print('Exception when calling ConfigApi->updateSystemConfig: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | **Object**| |
### Return type
[**SystemConfigResponseDto**](SystemConfigResponseDto.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)

15
mobile/openapi/doc/CreateJobDto.md generated
View File

@@ -1,15 +0,0 @@
# openapi.model.CreateJobDto
## Load the model package
```dart
import 'package:openapi/api.dart';
```
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**jobType** | [**JobType**](JobType.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)

39
mobile/openapi/doc/ExifEntity.md generated
View File

@@ -1,39 +0,0 @@
# 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)

15
mobile/openapi/doc/GetAssetCountByTimeGroupDto.md generated
View File

@@ -1,15 +0,0 @@
# openapi.model.GetAssetCountByTimeGroupDto
## Load the model package
```dart
import 'package:openapi/api.dart';
```
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**timeGroup** | [**TimeGroupEnum**](TimeGroupEnum.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)

14
mobile/openapi/doc/JobType.md generated
View File

@@ -1,14 +0,0 @@
# openapi.model.JobType
## 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)

19
mobile/openapi/doc/SmartInfoEntity.md generated
View File

@@ -1,19 +0,0 @@
# 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)

16
mobile/openapi/doc/SystemConfigEntity.md generated
View File

@@ -1,16 +0,0 @@
# openapi.model.SystemConfigEntity
## Load the model package
```dart
import 'package:openapi/api.dart';
```
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**key** | **String** | |
**value** | [**Object**](.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)

21
mobile/openapi/doc/TagEntity.md generated
View File

@@ -1,21 +0,0 @@
# 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)

14
mobile/openapi/doc/TimeBucketEnum.md generated
View File

@@ -1,14 +0,0 @@
# openapi.model.TimeBucketEnum
## 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)

27
mobile/openapi/doc/UserEntity.md generated
View File

@@ -1,27 +0,0 @@
# 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)