https://github.com/ahmetcavus/minio.apigatewaydart
The dart api gateway of minio
https://github.com/ahmetcavus/minio.apigatewaydart
Last synced: 2 months ago
JSON representation
The dart api gateway of minio
- Host: GitHub
- URL: https://github.com/ahmetcavus/minio.apigatewaydart
- Owner: AhmetCavus
- Created: 2021-09-17T22:16:56.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-10-23T07:00:00.000Z (over 3 years ago)
- Last Synced: 2025-03-22T18:44:35.134Z (2 months ago)
- Language: Dart
- Size: 17.3 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# openapi
This is the api for Minio.
This Dart package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.4.0
- Build package: org.openapitools.codegen.languages.DartClientCodegen
## Requirements
Dart 2.0 or later
## Installation & Usage
### Github
If this Dart package is published to Github, add the following dependency to your pubspec.yaml
```
dependencies:
openapi:
git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
### Local
To use the package in your local drive, add the following dependency to your pubspec.yaml
```
dependencies:
openapi:
path: /path/to/openapi
```
## Tests
TODO
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```dart
import 'package:openapi/api.dart';
final api_instance = AuthenticateApi();
final authBody = AuthBody(); // AuthBody |
try {
final result = api_instance.authenticatePost(authBody);
print(result);
} catch (e) {
print('Exception when calling AuthenticateApi->authenticatePost: $e\n');
}
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost:8080*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AuthenticateApi* | [**authenticatePost**](doc\/AuthenticateApi.md#authenticatepost) | **POST** /authenticate | Authentication for retrieving the token
*AuthenticateApi* | [**authenticateRegisterPost**](doc\/AuthenticateApi.md#authenticateregisterpost) | **POST** /authenticate/register | Create a new subscription
*ChannelApi* | [**channelChannelIdPost**](doc\/ChannelApi.md#channelchannelidpost) | **POST** /channel/{channelId} | Create a new chanel
*CollectionApi* | [**collectionSchemaGet**](doc\/CollectionApi.md#collectionschemaget) | **GET** /collection/{schema} | Gets a collection by name
*CollectionApi* | [**collectionSchemaIdDelete**](doc\/CollectionApi.md#collectionschemaiddelete) | **DELETE** /collection/{schema}/{id} | Deletes the item in the collection that matches the id
*CollectionApi* | [**collectionSchemaIdGet**](doc\/CollectionApi.md#collectionschemaidget) | **GET** /collection/{schema}/{id} | Gets the item in the collection depending on the given id
*CollectionApi* | [**collectionSchemaIdPopulatedGet**](doc\/CollectionApi.md#collectionschemaidpopulatedget) | **GET** /collection/{schema}/{id}/populated | Gets the populated item in the collection depending on the given id
*CollectionApi* | [**collectionSchemaIdPut**](doc\/CollectionApi.md#collectionschemaidput) | **PUT** /collection/{schema}/{id} | Replaces the item in the collection with the one in the request body
*CollectionApi* | [**collectionSchemaPopulatedGet**](doc\/CollectionApi.md#collectionschemapopulatedget) | **GET** /collection/{schema}/populated | Gets a collection by name with resolving the relations
*CollectionApi* | [**collectionSchemaPost**](doc\/CollectionApi.md#collectionschemapost) | **POST** /collection/{schema} | Adds a new item to the collection
*CollectionApi* | [**collectionSchemaPut**](doc\/CollectionApi.md#collectionschemaput) | **PUT** /collection/{schema} | Replaces the whole collection with the given one
## Documentation For Models
- [AuthBody](doc\/AuthBody.md)
- [AuthRegisterBody](doc\/AuthRegisterBody.md)
- [AuthRegisterResponse](doc\/AuthRegisterResponse.md)
- [AuthResponse](doc\/AuthResponse.md)
- [CreateChannelResponse](doc\/CreateChannelResponse.md)
## Documentation For Authorization
## bearerAuth
- **Type**: HTTP Bearer authentication
## Author