# openapi (EXPERIMENTAL)
Plane Pal API Documentation

This Dart package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.0
- Generator version: 7.16.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)

## Installation & Usage

### pub.dev
To use the package from [pub.dev](https://pub.dev), please include the following in pubspec.yaml
```yaml
dependencies:
  openapi: 1.0.0
```

### Github
If this Dart package is published to Github, please include the following in pubspec.yaml
```yaml
dependencies:
  openapi:
    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:
  openapi:
    path: /path/to/openapi
```

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```dart
import 'package:openapi/openapi.dart';


final api = Openapi().getAirlinesApi();
final String search = search_example; // String | The full(or a part of) name, ident or icao. Case Insensitive.

try {
    final response = await api.airlinesControllerGetAirlinesV1(search);
    print(response);
} catch on DioException (e) {
    print("Exception when calling AirlinesApi->airlinesControllerGetAirlinesV1: $e\n");
}

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
[*AirlinesApi*](doc/AirlinesApi.md) | [**airlinesControllerGetAirlinesV1**](doc/AirlinesApi.md#airlinescontrollergetairlinesv1) | **GET** /v1/airlines | Get airlines
[*AirportsApi*](doc/AirportsApi.md) | [**airportsControllerGetAirportsV1**](doc/AirportsApi.md#airportscontrollergetairportsv1) | **GET** /v1/airports | Get all airports
[*AppApi*](doc/AppApi.md) | [**appControllerGetHelloV1**](doc/AppApi.md#appcontrollergethellov1) | **GET** /v1 | 
[*AuthenticationApi*](doc/AuthenticationApi.md) | [**authControllerGetCurrentUserV1**](doc/AuthenticationApi.md#authcontrollergetcurrentuserv1) | **GET** /v1/auth/@me | Get current user
[*AuthenticationApi*](doc/AuthenticationApi.md) | [**authControllerLoginV1**](doc/AuthenticationApi.md#authcontrollerloginv1) | **POST** /v1/auth/login | Login
[*AuthenticationApi*](doc/AuthenticationApi.md) | [**authControllerRegisterV1**](doc/AuthenticationApi.md#authcontrollerregisterv1) | **POST** /v1/auth/register | Register
[*FlightApi*](doc/FlightApi.md) | [**flightControllerGetFlightV1**](doc/FlightApi.md#flightcontrollergetflightv1) | **GET** /v1/flight | Get flight details
[*FlightsApi*](doc/FlightsApi.md) | [**flightsControllerGetAirlineV1**](doc/FlightsApi.md#flightscontrollergetairlinev1) | **POST** /v1/flights/airline | Get airline
[*FlightsApi*](doc/FlightsApi.md) | [**flightsControllerGetFlightsInBoundsV1**](doc/FlightsApi.md#flightscontrollergetflightsinboundsv1) | **GET** /v1/flights/bounds | Get flights within geographic bounds
[*FlightsApi*](doc/FlightsApi.md) | [**flightsControllerGetFlightsV1**](doc/FlightsApi.md#flightscontrollergetflightsv1) | **GET** /v1/flights | Get flights between two airports


## Documentation For Models

 - [AircraftEntity](doc/AircraftEntity.md)
 - [AircraftFlightEntity](doc/AircraftFlightEntity.md)
 - [AirlineEntity](doc/AirlineEntity.md)
 - [AirlineInfo](doc/AirlineInfo.md)
 - [AirportEntity](doc/AirportEntity.md)
 - [AirportInfo](doc/AirportInfo.md)
 - [AirportType](doc/AirportType.md)
 - [FlighType](doc/FlighType.md)
 - [FlightEntity](doc/FlightEntity.md)
 - [FlightResponseEntity](doc/FlightResponseEntity.md)
 - [FlightStatus](doc/FlightStatus.md)
 - [FlightsControllerGetFlightsInBoundsV1200Response](doc/FlightsControllerGetFlightsInBoundsV1200Response.md)
 - [FlightsControllerGetFlightsInBoundsV1200ResponseBounds](doc/FlightsControllerGetFlightsInBoundsV1200ResponseBounds.md)
 - [FlightsControllerGetFlightsInBoundsV1200ResponseFlightsInner](doc/FlightsControllerGetFlightsInBoundsV1200ResponseFlightsInner.md)
 - [FlightsControllerGetFlightsInBoundsV1200ResponseFlightsInnerOrigin](doc/FlightsControllerGetFlightsInBoundsV1200ResponseFlightsInnerOrigin.md)
 - [FlightsResponseEntity](doc/FlightsResponseEntity.md)
 - [FlightsRouteEntity](doc/FlightsRouteEntity.md)
 - [GenericErrorEntity](doc/GenericErrorEntity.md)
 - [GetAirlineDTO](doc/GetAirlineDTO.md)
 - [LocationEntity](doc/LocationEntity.md)
 - [LoginDTO](doc/LoginDTO.md)
 - [LoginEntity](doc/LoginEntity.md)
 - [PartialAirlineEntity](doc/PartialAirlineEntity.md)
 - [RegisterDTO](doc/RegisterDTO.md)
 - [RegisterEntity](doc/RegisterEntity.md)
 - [RouteAirportEntity](doc/RouteAirportEntity.md)
 - [RouteInfoEntity](doc/RouteInfoEntity.md)
 - [StringifiedGreatCircleDistanceEntity](doc/StringifiedGreatCircleDistanceEntity.md)
 - [TimeEntity](doc/TimeEntity.md)
 - [UserEntity](doc/UserEntity.md)


## Documentation For Authorization


Authentication schemes defined for the API:
### JWT-auth

- **Type**: HTTP Bearer Token authentication (JWT)


## Author