Dmitry
bfe74ca47c
Портфели, создание счетов, ручные события, PATCH инструмента, ScopeCardOut, MetricsStatusOut, логотипы в HoldingOut.
54 lines
1.2 KiB
Markdown
54 lines
1.2 KiB
Markdown
# fintracker_api.api.HealthApi
|
|
|
|
## Load the API package
|
|
```dart
|
|
import 'package:fintracker_api/api.dart';
|
|
```
|
|
|
|
All URIs are relative to *http://localhost*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**healthCheck**](HealthApi.md#healthcheck) | **GET** /api/v1/health | Check
|
|
|
|
|
|
# **healthCheck**
|
|
> Health healthCheck()
|
|
|
|
Check
|
|
|
|
503 when the database cannot be reached, so a container healthcheck can trust the code.
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:fintracker_api/api.dart';
|
|
|
|
final api = FintrackerApi().getHealthApi();
|
|
|
|
try {
|
|
final response = api.healthCheck();
|
|
print(response);
|
|
} on DioException catch (e) {
|
|
print('Exception when calling HealthApi->healthCheck: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
This endpoint does not need any parameter.
|
|
|
|
### Return type
|
|
|
|
[**Health**](Health.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### 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)
|
|
|