mirror of
https://github.com/immich-app/immich.git
synced 2024-12-21 01:39:59 +02:00
18f59f78e3
* feat(web): onboarding * feat: openapi * feat: modulization * feat: page advancing * Animation * Add storage templaete settings * sql * more style * Theme * information and styling * hide/show table * Styling * Update user property * fix test * fix test: * fix e2e * test * Update web/src/lib/components/onboarding-page/onboarding-hello.svelte Co-authored-by: bo0tzz <git@bo0tzz.me> * naming * use System Metadata * better return type * onboarding using server metadata * revert previous changes in user entity * sql * test web * fix test server * server/web test * more test * consolidate color theme change logic * consolidate save button to storage template * merge main * fix web --------- Co-authored-by: bo0tzz <git@bo0tzz.me>
397 lines
11 KiB
Markdown
Generated
397 lines
11 KiB
Markdown
Generated
# openapi.api.ServerInfoApi
|
|
|
|
## Load the API package
|
|
```dart
|
|
import 'package:openapi/api.dart';
|
|
```
|
|
|
|
All URIs are relative to */api*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**getServerConfig**](ServerInfoApi.md#getserverconfig) | **GET** /server-info/config |
|
|
[**getServerFeatures**](ServerInfoApi.md#getserverfeatures) | **GET** /server-info/features |
|
|
[**getServerInfo**](ServerInfoApi.md#getserverinfo) | **GET** /server-info |
|
|
[**getServerStatistics**](ServerInfoApi.md#getserverstatistics) | **GET** /server-info/statistics |
|
|
[**getServerVersion**](ServerInfoApi.md#getserverversion) | **GET** /server-info/version |
|
|
[**getSupportedMediaTypes**](ServerInfoApi.md#getsupportedmediatypes) | **GET** /server-info/media-types |
|
|
[**getTheme**](ServerInfoApi.md#gettheme) | **GET** /server-info/theme |
|
|
[**pingServer**](ServerInfoApi.md#pingserver) | **GET** /server-info/ping |
|
|
[**setAdminOnboarding**](ServerInfoApi.md#setadminonboarding) | **POST** /server-info/admin-onboarding |
|
|
|
|
|
|
# **getServerConfig**
|
|
> ServerConfigDto getServerConfig()
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:openapi/api.dart';
|
|
|
|
final api_instance = ServerInfoApi();
|
|
|
|
try {
|
|
final result = api_instance.getServerConfig();
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling ServerInfoApi->getServerConfig: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
This endpoint does not need any parameter.
|
|
|
|
### Return type
|
|
|
|
[**ServerConfigDto**](ServerConfigDto.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)
|
|
|
|
# **getServerFeatures**
|
|
> ServerFeaturesDto getServerFeatures()
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:openapi/api.dart';
|
|
|
|
final api_instance = ServerInfoApi();
|
|
|
|
try {
|
|
final result = api_instance.getServerFeatures();
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling ServerInfoApi->getServerFeatures: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
This endpoint does not need any parameter.
|
|
|
|
### Return type
|
|
|
|
[**ServerFeaturesDto**](ServerFeaturesDto.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)
|
|
|
|
# **getServerInfo**
|
|
> ServerInfoResponseDto getServerInfo()
|
|
|
|
|
|
|
|
### 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 = ServerInfoApi();
|
|
|
|
try {
|
|
final result = api_instance.getServerInfo();
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling ServerInfoApi->getServerInfo: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
This endpoint does not need any parameter.
|
|
|
|
### Return type
|
|
|
|
[**ServerInfoResponseDto**](ServerInfoResponseDto.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)
|
|
|
|
# **getServerStatistics**
|
|
> ServerStatsResponseDto getServerStatistics()
|
|
|
|
|
|
|
|
### 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 = ServerInfoApi();
|
|
|
|
try {
|
|
final result = api_instance.getServerStatistics();
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling ServerInfoApi->getServerStatistics: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
This endpoint does not need any parameter.
|
|
|
|
### Return type
|
|
|
|
[**ServerStatsResponseDto**](ServerStatsResponseDto.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)
|
|
|
|
# **getServerVersion**
|
|
> ServerVersionResponseDto getServerVersion()
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:openapi/api.dart';
|
|
|
|
final api_instance = ServerInfoApi();
|
|
|
|
try {
|
|
final result = api_instance.getServerVersion();
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling ServerInfoApi->getServerVersion: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
This endpoint does not need any parameter.
|
|
|
|
### Return type
|
|
|
|
[**ServerVersionResponseDto**](ServerVersionResponseDto.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)
|
|
|
|
# **getSupportedMediaTypes**
|
|
> ServerMediaTypesResponseDto getSupportedMediaTypes()
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:openapi/api.dart';
|
|
|
|
final api_instance = ServerInfoApi();
|
|
|
|
try {
|
|
final result = api_instance.getSupportedMediaTypes();
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling ServerInfoApi->getSupportedMediaTypes: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
This endpoint does not need any parameter.
|
|
|
|
### Return type
|
|
|
|
[**ServerMediaTypesResponseDto**](ServerMediaTypesResponseDto.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)
|
|
|
|
# **getTheme**
|
|
> ServerThemeDto getTheme()
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:openapi/api.dart';
|
|
|
|
final api_instance = ServerInfoApi();
|
|
|
|
try {
|
|
final result = api_instance.getTheme();
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling ServerInfoApi->getTheme: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
This endpoint does not need any parameter.
|
|
|
|
### Return type
|
|
|
|
[**ServerThemeDto**](ServerThemeDto.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)
|
|
|
|
# **pingServer**
|
|
> ServerPingResponse pingServer()
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:openapi/api.dart';
|
|
|
|
final api_instance = ServerInfoApi();
|
|
|
|
try {
|
|
final result = api_instance.pingServer();
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling ServerInfoApi->pingServer: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
This endpoint does not need any parameter.
|
|
|
|
### Return type
|
|
|
|
[**ServerPingResponse**](ServerPingResponse.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)
|
|
|
|
# **setAdminOnboarding**
|
|
> setAdminOnboarding()
|
|
|
|
|
|
|
|
### 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 = ServerInfoApi();
|
|
|
|
try {
|
|
api_instance.setAdminOnboarding();
|
|
} catch (e) {
|
|
print('Exception when calling ServerInfoApi->setAdminOnboarding: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
This endpoint does not need any parameter.
|
|
|
|
### Return type
|
|
|
|
void (empty response body)
|
|
|
|
### Authorization
|
|
|
|
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: Not defined
|
|
|
|
[[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)
|
|
|