Dmitry
90ba198c2a
openapi-generator-cli -g dart-dio. Генерируется, но коммитится: CI ловит дрейф openapi/openapi.json, а приложение собирается без запуска генератора. Пересобирается через just gen-client после любого изменения роутов.
134 lines
3.2 KiB
Markdown
134 lines
3.2 KiB
Markdown
# fintracker_api.api.MetricsApi
|
|
|
|
## Load the API package
|
|
```dart
|
|
import 'package:fintracker_api/api.dart';
|
|
```
|
|
|
|
All URIs are relative to *http://localhost*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**metricsDataQuality**](MetricsApi.md#metricsdataquality) | **GET** /api/v1/data-quality | Data Quality
|
|
[**metricsRefresh**](MetricsApi.md#metricsrefresh) | **POST** /api/v1/metrics/refresh | Refresh
|
|
[**metricsStatus**](MetricsApi.md#metricsstatus) | **GET** /api/v1/metrics/status | Status
|
|
|
|
|
|
# **metricsDataQuality**
|
|
> List<DataQualityRow> metricsDataQuality()
|
|
|
|
Data Quality
|
|
|
|
Findings of the latest refresh, most serious first.
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:fintracker_api/api.dart';
|
|
|
|
final api = FintrackerApi().getMetricsApi();
|
|
|
|
try {
|
|
final response = api.metricsDataQuality();
|
|
print(response);
|
|
} on DioException catch (e) {
|
|
print('Exception when calling MetricsApi->metricsDataQuality: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
This endpoint does not need any parameter.
|
|
|
|
### Return type
|
|
|
|
[**List<DataQualityRow>**](DataQualityRow.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)
|
|
|
|
# **metricsRefresh**
|
|
> RefreshLogOut metricsRefresh()
|
|
|
|
Refresh
|
|
|
|
Rebuild every metric_* table inline (seconds at personal volumes).
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:fintracker_api/api.dart';
|
|
|
|
final api = FintrackerApi().getMetricsApi();
|
|
|
|
try {
|
|
final response = api.metricsRefresh();
|
|
print(response);
|
|
} on DioException catch (e) {
|
|
print('Exception when calling MetricsApi->metricsRefresh: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
This endpoint does not need any parameter.
|
|
|
|
### Return type
|
|
|
|
[**RefreshLogOut**](RefreshLogOut.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)
|
|
|
|
# **metricsStatus**
|
|
> RefreshLogOut metricsStatus()
|
|
|
|
Status
|
|
|
|
When the metric tables were last rebuilt, and whether it failed.
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:fintracker_api/api.dart';
|
|
|
|
final api = FintrackerApi().getMetricsApi();
|
|
|
|
try {
|
|
final response = api.metricsStatus();
|
|
print(response);
|
|
} on DioException catch (e) {
|
|
print('Exception when calling MetricsApi->metricsStatus: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
This endpoint does not need any parameter.
|
|
|
|
### Return type
|
|
|
|
[**RefreshLogOut**](RefreshLogOut.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)
|
|
|