124 lines
5.0 KiB
Markdown
124 lines
5.0 KiB
Markdown
# managerapi
|
|
API Manager Service
|
|
|
|
This Dart package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
|
|
- API version: Version Alpha
|
|
- 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:
|
|
managerapi:
|
|
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:
|
|
managerapi:
|
|
path: /path/to/managerapi
|
|
```
|
|
|
|
## Tests
|
|
|
|
TODO
|
|
|
|
## Getting Started
|
|
|
|
Please follow the [installation procedure](#installation--usage) and then run the following:
|
|
|
|
```dart
|
|
import 'package:managerapi/api.dart';
|
|
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = AuthenticationApi();
|
|
final grantType = grantType_example; // String |
|
|
final username = username_example; // String |
|
|
final password = password_example; // String |
|
|
final clientId = clientId_example; // String |
|
|
final clientSecret = clientSecret_example; // String |
|
|
|
|
try {
|
|
final result = api_instance.authenticationAuthenticateWithForm(grantType, username, password, clientId, clientSecret);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling AuthenticationApi->authenticationAuthenticateWithForm: $e\n');
|
|
}
|
|
|
|
```
|
|
|
|
## Documentation for API Endpoints
|
|
|
|
All URIs are relative to *http://192.168.31.96*
|
|
|
|
Class | Method | HTTP request | Description
|
|
------------ | ------------- | ------------- | -------------
|
|
*AuthenticationApi* | [**authenticationAuthenticateWithForm**](doc\/AuthenticationApi.md#authenticationauthenticatewithform) | **POST** /api/Authentication/Token |
|
|
*AuthenticationApi* | [**authenticationAuthenticateWithJson**](doc\/AuthenticationApi.md#authenticationauthenticatewithjson) | **POST** /api/Authentication/Authenticate |
|
|
*ConfigurationApi* | [**configurationCreate**](doc\/ConfigurationApi.md#configurationcreate) | **POST** /api/Configuration |
|
|
*ConfigurationApi* | [**configurationDelete**](doc\/ConfigurationApi.md#configurationdelete) | **DELETE** /api/Configuration/{id} |
|
|
*ConfigurationApi* | [**configurationGet**](doc\/ConfigurationApi.md#configurationget) | **GET** /api/Configuration |
|
|
*ConfigurationApi* | [**configurationGetDetail**](doc\/ConfigurationApi.md#configurationgetdetail) | **GET** /api/Configuration/{id} |
|
|
*ConfigurationApi* | [**configurationUpdate**](doc\/ConfigurationApi.md#configurationupdate) | **PUT** /api/Configuration |
|
|
*RessourceApi* | [**ressourceCreate**](doc\/RessourceApi.md#ressourcecreate) | **POST** /api/Ressource |
|
|
*RessourceApi* | [**ressourceDelete**](doc\/RessourceApi.md#ressourcedelete) | **DELETE** /api/Ressource/{id} |
|
|
*RessourceApi* | [**ressourceGet**](doc\/RessourceApi.md#ressourceget) | **GET** /api/Ressource |
|
|
*RessourceApi* | [**ressourceGetDetail**](doc\/RessourceApi.md#ressourcegetdetail) | **GET** /api/Ressource/{id}/detail |
|
|
*RessourceApi* | [**ressourceShow**](doc\/RessourceApi.md#ressourceshow) | **GET** /api/Ressource/{id} |
|
|
*RessourceApi* | [**ressourceUpdate**](doc\/RessourceApi.md#ressourceupdate) | **PUT** /api/Ressource |
|
|
*SectionApi* | [**sectionCreate**](doc\/SectionApi.md#sectioncreate) | **POST** /api/Section |
|
|
*SectionApi* | [**sectionDelete**](doc\/SectionApi.md#sectiondelete) | **DELETE** /api/Section/{id} |
|
|
*SectionApi* | [**sectionGet**](doc\/SectionApi.md#sectionget) | **GET** /api/Section |
|
|
*SectionApi* | [**sectionGetAllSectionSubSections**](doc\/SectionApi.md#sectiongetallsectionsubsections) | **GET** /api/Section/{id}/subsections |
|
|
*SectionApi* | [**sectionGetDetail**](doc\/SectionApi.md#sectiongetdetail) | **GET** /api/Section/{id} |
|
|
*SectionApi* | [**sectionUpdate**](doc\/SectionApi.md#sectionupdate) | **PUT** /api/Section |
|
|
*UserApi* | [**userCreateUser**](doc\/UserApi.md#usercreateuser) | **POST** /api/User |
|
|
*UserApi* | [**userDeleteUser**](doc\/UserApi.md#userdeleteuser) | **DELETE** /api/User/{id} |
|
|
*UserApi* | [**userGet**](doc\/UserApi.md#userget) | **GET** /api/User |
|
|
*UserApi* | [**userGetDetail**](doc\/UserApi.md#usergetdetail) | **GET** /api/User/{id} |
|
|
*UserApi* | [**userUpdateUser**](doc\/UserApi.md#userupdateuser) | **PUT** /api/User |
|
|
|
|
|
|
## Documentation For Models
|
|
|
|
- [ConfigurationDTO](doc\/ConfigurationDTO.md)
|
|
- [LoginDTO](doc\/LoginDTO.md)
|
|
- [RessourceDTO](doc\/RessourceDTO.md)
|
|
- [RessourceDetailDTO](doc\/RessourceDetailDTO.md)
|
|
- [RessourceType](doc\/RessourceType.md)
|
|
- [SectionDTO](doc\/SectionDTO.md)
|
|
- [SectionType](doc\/SectionType.md)
|
|
- [TokenDTO](doc\/TokenDTO.md)
|
|
- [User](doc\/User.md)
|
|
- [UserDetailDTO](doc\/UserDetailDTO.md)
|
|
|
|
|
|
## Documentation For Authorization
|
|
|
|
|
|
## bearer
|
|
|
|
- **Type**: OAuth
|
|
- **Flow**: password
|
|
- **Authorization URL**: /authentication/Token
|
|
- **Scopes**:
|
|
- **Manager-api**: Manager WebAPI
|
|
|
|
|
|
## Author
|
|
|
|
|
|
|
|
|