mirror of
https://github.com/immich-app/immich.git
synced 2024-12-26 10:50:29 +02:00
177 lines
6.1 KiB
Markdown
177 lines
6.1 KiB
Markdown
|
# openapi.api.FileReportApi
|
||
|
|
|
||
|
|
## Load the API package
|
||
|
|
```dart
|
||
|
|
import 'package:openapi/api.dart';
|
||
|
|
```
|
||
|
|
|
||
|
|
All URIs are relative to */api*
|
||
|
|
|
||
|
|
Method | HTTP request | Description
|
||
|
|
------------- | ------------- | -------------
|
||
|
|
[**fixAuditFiles**](FileReportApi.md#fixauditfiles) | **POST** /report/fix |
|
||
|
|
[**getAuditFiles**](FileReportApi.md#getauditfiles) | **GET** /report |
|
||
|
|
[**getFileChecksums**](FileReportApi.md#getfilechecksums) | **POST** /report/checksum |
|
||
|
|
|
||
|
|
|
||
|
|
# **fixAuditFiles**
|
||
|
|
> fixAuditFiles(fileReportFixDto)
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
### 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 = FileReportApi();
|
||
|
|
final fileReportFixDto = FileReportFixDto(); // FileReportFixDto |
|
||
|
|
|
||
|
|
try {
|
||
|
|
api_instance.fixAuditFiles(fileReportFixDto);
|
||
|
|
} catch (e) {
|
||
|
|
print('Exception when calling FileReportApi->fixAuditFiles: $e\n');
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
### Parameters
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**fileReportFixDto** | [**FileReportFixDto**](FileReportFixDto.md)| |
|
||
|
|
|
||
|
|
### 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**: application/json
|
||
|
|
- **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)
|
||
|
|
|
||
|
|
# **getAuditFiles**
|
||
|
|
> FileReportDto getAuditFiles()
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
### 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 = FileReportApi();
|
||
|
|
|
||
|
|
try {
|
||
|
|
final result = api_instance.getAuditFiles();
|
||
|
|
print(result);
|
||
|
|
} catch (e) {
|
||
|
|
print('Exception when calling FileReportApi->getAuditFiles: $e\n');
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
### Parameters
|
||
|
|
This endpoint does not need any parameter.
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
[**FileReportDto**](FileReportDto.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)
|
||
|
|
|
||
|
|
# **getFileChecksums**
|
||
|
|
> List<FileChecksumResponseDto> getFileChecksums(fileChecksumDto)
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
### 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 = FileReportApi();
|
||
|
|
final fileChecksumDto = FileChecksumDto(); // FileChecksumDto |
|
||
|
|
|
||
|
|
try {
|
||
|
|
final result = api_instance.getFileChecksums(fileChecksumDto);
|
||
|
|
print(result);
|
||
|
|
} catch (e) {
|
||
|
|
print('Exception when calling FileReportApi->getFileChecksums: $e\n');
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
### Parameters
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**fileChecksumDto** | [**FileChecksumDto**](FileChecksumDto.md)| |
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
[**List<FileChecksumResponseDto>**](FileChecksumResponseDto.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)
|
||
|
|
|