mirror of
https://github.com/immich-app/immich.git
synced 2025-01-07 20:36:48 +01:00
106 lines
2.8 KiB
Markdown
106 lines
2.8 KiB
Markdown
|
# 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)
|
||
|
|
|