chore(app): сгенерированный Dart-клиент из OpenAPI
openapi-generator-cli -g dart-dio. Генерируется, но коммитится: CI ловит дрейф openapi/openapi.json, а приложение собирается без запуска генератора. Пересобирается через just gen-client после любого изменения роутов.
This commit is contained in:
@@ -0,0 +1,99 @@
|
||||
# fintracker_api.api.AccountsApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**accountsList**](AccountsApi.md#accountslist) | **GET** /api/v1/accounts | List
|
||||
[**accountsPatch**](AccountsApi.md#accountspatch) | **PATCH** /api/v1/accounts/{account_id} | Patch
|
||||
|
||||
|
||||
# **accountsList**
|
||||
> List<AccountOut> accountsList()
|
||||
|
||||
List
|
||||
|
||||
Every account, archived ones included — the client decides what to show.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getAccountsApi();
|
||||
|
||||
try {
|
||||
final response = api.accountsList();
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling AccountsApi->accountsList: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**List<AccountOut>**](AccountOut.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)
|
||||
|
||||
# **accountsPatch**
|
||||
> AccountOut accountsPatch(accountId, accountPatch)
|
||||
|
||||
Patch
|
||||
|
||||
Update the user-owned fields. Everything else is overwritten by the next sync.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getAccountsApi();
|
||||
final int accountId = 56; // int |
|
||||
final AccountPatch accountPatch = ; // AccountPatch |
|
||||
|
||||
try {
|
||||
final response = api.accountsPatch(accountId, accountPatch);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling AccountsApi->accountsPatch: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**accountId** | **int**| |
|
||||
**accountPatch** | [**AccountPatch**](AccountPatch.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**AccountOut**](AccountOut.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **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)
|
||||
|
||||
Reference in New Issue
Block a user