Tuuli/tuuli_api
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Api upgrade

Browse source
This commit is contained in:
Andrew 2023-04-24 20:58:26 +07:00
parent aa04b550c6
commit 9e67cc912b
11 changed files with 392 additions and 107 deletions
Download patch file Download diff file Expand all files Collapse all files

110
README.md
View file

@ -1,48 +1,43 @@
# tuuli_api (EXPERIMENTAL)
Tuuli API for Tuuli frontend
Use `c2316f9686e7a764688b8c1b4c60c5a088b07a3c23a2f6b7c25915a5118d7acc` as access token to test the API
This Dart package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 0.1.0
- Build package: org.openapitools.codegen.languages.DartDioClientCodegen
- API version: 0.1.0
- Build package: org.openapitools.codegen.languages.DartDioClientCodegen
## Requirements
- Dart 2.15.0+ or Flutter 2.8.0+
- Dio 5.0.0+ (https://pub.dev/packages/dio)
* Dart 2.15.0+ or Flutter 2.8.0+
* Dio 5.0.0+ (https://pub.dev/packages/dio)
## Installation & Usage
### pub.dev
To use the package from [pub.dev](https://pub.dev), please include the following in pubspec.yaml
```yaml
dependencies:
tuuli_api: 1.0.0
tuuli_api: 1.0.0
```
### Github
If this Dart package is published to Github, please include the following in pubspec.yaml
```yaml
dependencies:
tuuli_api:
git:
url: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
#ref: main
tuuli_api:
git:
url: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
#ref: main
```
### Local development
To use the package from your local drive, please include the following in pubspec.yaml
```yaml
dependencies:
tuuli_api:
path: /path/to/tuuli_api
tuuli_api:
path: /path/to/tuuli_api
```
## Getting Started
@ -54,9 +49,9 @@ import 'package:tuuli_api/tuuli_api.dart';
final api = TuuliApi().getDefaultApi();
final String tableName = tableName_example; // String |
final JsonObject body = Object; // JsonObject |
final String accessToken = accessToken_example; // String |
final String tableName = tableName_example; // String |
final JsonObject body = Object; // JsonObject |
final String accessToken = accessToken_example; // String |
try {
final response = await api.createItemItemsTableNamePost(tableName, body, accessToken);
@ -69,46 +64,51 @@ try {
## Documentation for API Endpoints
All URIs are relative to _http://localhost_
All URIs are relative to *http://localhost*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
[*DefaultApi*](doc\DefaultApi.md) | [**createItemItemsTableNamePost**](doc\DefaultApi.md#createitemitemstablenamepost) | **POST** /items/{tableName}/+ | Create Item
[*DefaultApi*](doc\DefaultApi.md) | [**createTableApiCreateTableTableNamePost**](doc\DefaultApi.md#createtableapicreatetabletablenamepost) | **POST** /api/createTable/{tableName} | Create Table
[*DefaultApi*](doc\DefaultApi.md) | [**createUserApiUsersPost**](doc\DefaultApi.md#createuserapiuserspost) | **POST** /api/users/+ | Create User
[*DefaultApi*](doc\DefaultApi.md) | [**deleteItemFromTableItemsTableNamePost**](doc\DefaultApi.md#deleteitemfromtableitemstablenamepost) | **POST** /items/{tableName}/- | Delete Item From Table
[*DefaultApi*](doc\DefaultApi.md) | [**dropTableApiDropTableTableNamePost**](doc\DefaultApi.md#droptableapidroptabletablenamepost) | **POST** /api/dropTable/{tableName} | Drop Table
[*DefaultApi*](doc\DefaultApi.md) | [**getAccessTokenApiGetAccessTokenPost**](doc\DefaultApi.md#getaccesstokenapigetaccesstokenpost) | **POST** /api/getAccessToken | Get Access Token
[*DefaultApi*](doc\DefaultApi.md) | [**getAssetAssetsFidGet**](doc\DefaultApi.md#getassetassetsfidget) | **GET** /assets/{fid} | Get Asset
[*DefaultApi*](doc\DefaultApi.md) | [**getItemsFromTableItemsTableNamePost**](doc\DefaultApi.md#getitemsfromtableitemstablenamepost) | **POST** /items/{tableName} | Get Items From Table
[*DefaultApi*](doc\DefaultApi.md) | [**listTablesApiListTablesGet**](doc\DefaultApi.md#listtablesapilisttablesget) | **GET** /api/listTables | List Tables
[*DefaultApi*](doc\DefaultApi.md) | [**putAssetAssetsPost**](doc\DefaultApi.md#putassetassetspost) | **POST** /assets/+ | Put Asset
[*DefaultApi*](doc\DefaultApi.md) | [**removeAssetAssetsAssetIdPost**](doc\DefaultApi.md#removeassetassetsassetidpost) | **POST** /assets/{asset_id}/- | Remove Asset
[*DefaultApi*](doc\DefaultApi.md) | [**removeUserApiUsersPost**](doc\DefaultApi.md#removeuserapiuserspost) | **POST** /api/users/- | Remove User
[*DefaultApi*](doc\DefaultApi.md) | [**updateAssetDescriptionAssetsAssetIdPost**](doc\DefaultApi.md#updateassetdescriptionassetsassetidpost) | **POST** /assets/{asset_id}/* | Update Asset Description
[*DefaultApi*](doc\DefaultApi.md) | [**updateItemInTableItemsTableNamePost**](doc\DefaultApi.md#updateitemintableitemstablenamepost) | **POST** /items/{tableName}/* | Update Item In Table
[*DefaultApi*](doc\DefaultApi.md) | [**updateUserApiUsersPost**](doc\DefaultApi.md#updateuserapiuserspost) | **POST** /api/users/* | Update User
| Class | Method | HTTP request | Description |
| --------------------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------- | ------------------------ |
| [_DefaultApi_](doc\DefaultApi.md) | [**createItemItemsTableNamePost**](doc\DefaultApi.md#createitemitemstablenamepost) | **POST** /items/{tableName}/+ | Create Item |
| [_DefaultApi_](doc\DefaultApi.md) | [**createTableApiCreateTableTableNamePost**](doc\DefaultApi.md#createtableapicreatetabletablenamepost) | **POST** /api/createTable/{tableName} | Create Table |
| [_DefaultApi_](doc\DefaultApi.md) | [**createUserApiUsersPost**](doc\DefaultApi.md#createuserapiuserspost) | **POST** /api/users/+ | Create User |
| [_DefaultApi_](doc\DefaultApi.md) | [**deleteItemFromTableItemsTableNamePost**](doc\DefaultApi.md#deleteitemfromtableitemstablenamepost) | **POST** /items/{tableName}/- | Delete Item From Table |
| [_DefaultApi_](doc\DefaultApi.md) | [**dropTableApiDropTableTableNamePost**](doc\DefaultApi.md#droptableapidroptabletablenamepost) | **POST** /api/dropTable/{tableName} | Drop Table |
| [_DefaultApi_](doc\DefaultApi.md) | [**getAccessTokenApiGetAccessTokenPost**](doc\DefaultApi.md#getaccesstokenapigetaccesstokenpost) | **POST** /api/getAccessToken | Get Access Token |
| [_DefaultApi_](doc\DefaultApi.md) | [**getAssetAssetsFidGet**](doc\DefaultApi.md#getassetassetsfidget) | **GET** /assets/{fid} | Get Asset |
| [_DefaultApi_](doc\DefaultApi.md) | [**getItemsFromTableItemsTableNamePost**](doc\DefaultApi.md#getitemsfromtableitemstablenamepost) | **POST** /items/{tableName} | Get Items From Table |
| [_DefaultApi_](doc\DefaultApi.md) | [**listTablesApiListTablesGet**](doc\DefaultApi.md#listtablesapilisttablesget) | **GET** /api/listTables | List Tables |
| [_DefaultApi_](doc\DefaultApi.md) | [**putAssetAssetsPost**](doc\DefaultApi.md#putassetassetspost) | **POST** /assets/+ | Put Asset |
| [_DefaultApi_](doc\DefaultApi.md) | [**removeAssetAssetsAssetIdPost**](doc\DefaultApi.md#removeassetassetsassetidpost) | **POST** /assets/{asset_id}/- | Remove Asset |
| [_DefaultApi_](doc\DefaultApi.md) | [**removeUserApiUsersPost**](doc\DefaultApi.md#removeuserapiuserspost) | **POST** /api/users/- | Remove User |
| [_DefaultApi_](doc\DefaultApi.md) | [**updateAssetDescriptionAssetsAssetIdPost**](doc\DefaultApi.md#updateassetdescriptionassetsassetidpost) | **POST** /assets/{asset_id}/\* | Update Asset Description |
| [_DefaultApi_](doc\DefaultApi.md) | [**updateItemInTableItemsTableNamePost**](doc\DefaultApi.md#updateitemintableitemstablenamepost) | **POST** /items/{tableName}/\* | Update Item In Table |
| [_DefaultApi_](doc\DefaultApi.md) | [**updateUserApiUsersPost**](doc\DefaultApi.md#updateuserapiuserspost) | **POST** /api/users/\* | Update User |
## Documentation For Models
- [AccessTokenResponse](doc\AccessTokenResponse.md)
- [AuthModel](doc\AuthModel.md)
- [BodyUpdateItemInTableItemsTableNamePost](doc\BodyUpdateItemInTableItemsTableNamePost.md)
- [ColumnConditionCompat](doc\ColumnConditionCompat.md)
- [CreateAssetResponse](doc\CreateAssetResponse.md)
- [CreateUserDefinition](doc\CreateUserDefinition.md)
- [ErrorResponse](doc\ErrorResponse.md)
- [HTTPValidationError](doc\HTTPValidationError.md)
- [ItemsFieldSelectorList](doc\ItemsFieldSelectorList.md)
- [LocationInner](doc\LocationInner.md)
- [OkResponse](doc\OkResponse.md)
- [TableDefinition](doc\TableDefinition.md)
- [TableItemsResponse](doc\TableItemsResponse.md)
- [UserUpdateDefinition](doc\UserUpdateDefinition.md)
- [ValidationError](doc\ValidationError.md)
- [AccessTokenResponse](doc\AccessTokenResponse.md)
- [AuthModel](doc\AuthModel.md)
- [BodyGetItemsFromTableItemsTableNamePost](doc\BodyGetItemsFromTableItemsTableNamePost.md)
- [BodyUpdateItemInTableItemsTableNamePost](doc\BodyUpdateItemInTableItemsTableNamePost.md)
- [ColumnConditionCompat](doc\ColumnConditionCompat.md)
- [CreateAssetResponse](doc\CreateAssetResponse.md)
- [CreateUserDefinition](doc\CreateUserDefinition.md)
- [ErrorResponse](doc\ErrorResponse.md)
- [HTTPValidationError](doc\HTTPValidationError.md)
- [LocationInner](doc\LocationInner.md)
- [OkResponse](doc\OkResponse.md)
- [TableDefinition](doc\TableDefinition.md)
- [UserUpdateDefinition](doc\UserUpdateDefinition.md)
- [ValidationError](doc\ValidationError.md)
## Documentation For Authorization
All endpoints do not require authorization.
All endpoints do not require authorization.
## Author