Dmitry
90ba198c2a
openapi-generator-cli -g dart-dio. Генерируется, но коммитится: CI ловит дрейф openapi/openapi.json, а приложение собирается без запуска генератора. Пересобирается через just gen-client после любого изменения роутов.
138 lines
3.2 KiB
Markdown
138 lines
3.2 KiB
Markdown
# fintracker_api.api.SyncApi
|
|
|
|
## Load the API package
|
|
```dart
|
|
import 'package:fintracker_api/api.dart';
|
|
```
|
|
|
|
All URIs are relative to *http://localhost*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**syncRuns**](SyncApi.md#syncruns) | **GET** /api/v1/sync/runs | Runs
|
|
[**syncStatus**](SyncApi.md#syncstatus) | **GET** /api/v1/sync/status | Status
|
|
[**syncTrigger**](SyncApi.md#synctrigger) | **POST** /api/v1/sync/{source} | Trigger
|
|
|
|
|
|
# **syncRuns**
|
|
> List<SyncRunOut> syncRuns(source_, limit)
|
|
|
|
Runs
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:fintracker_api/api.dart';
|
|
|
|
final api = FintrackerApi().getSyncApi();
|
|
final String source_ = source__example; // String |
|
|
final int limit = 56; // int |
|
|
|
|
try {
|
|
final response = api.syncRuns(source_, limit);
|
|
print(response);
|
|
} on DioException catch (e) {
|
|
print('Exception when calling SyncApi->syncRuns: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**source_** | **String**| | [optional]
|
|
**limit** | **int**| | [optional] [default to 20]
|
|
|
|
### Return type
|
|
|
|
[**List<SyncRunOut>**](SyncRunOut.md)
|
|
|
|
### Authorization
|
|
|
|
[HTTPBearer](../README.md#HTTPBearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json, application/problem+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)
|
|
|
|
# **syncStatus**
|
|
> List<SourceStatus> syncStatus()
|
|
|
|
Status
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:fintracker_api/api.dart';
|
|
|
|
final api = FintrackerApi().getSyncApi();
|
|
|
|
try {
|
|
final response = api.syncStatus();
|
|
print(response);
|
|
} on DioException catch (e) {
|
|
print('Exception when calling SyncApi->syncStatus: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
This endpoint does not need any parameter.
|
|
|
|
### Return type
|
|
|
|
[**List<SourceStatus>**](SourceStatus.md)
|
|
|
|
### Authorization
|
|
|
|
[HTTPBearer](../README.md#HTTPBearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json, application/problem+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)
|
|
|
|
# **syncTrigger**
|
|
> SyncJobOut syncTrigger(source_)
|
|
|
|
Trigger
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:fintracker_api/api.dart';
|
|
|
|
final api = FintrackerApi().getSyncApi();
|
|
final String source_ = source__example; // String |
|
|
|
|
try {
|
|
final response = api.syncTrigger(source_);
|
|
print(response);
|
|
} on DioException catch (e) {
|
|
print('Exception when calling SyncApi->syncTrigger: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**source_** | **String**| |
|
|
|
|
### Return type
|
|
|
|
[**SyncJobOut**](SyncJobOut.md)
|
|
|
|
### Authorization
|
|
|
|
[HTTPBearer](../README.md#HTTPBearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json, application/problem+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)
|
|
|