phpvms/swagger.yml
Nabeel S 2415caab54
Search flights by subfleet #484 (#506)
* API level search of flights #484

* Add Subfleet to flights page for search
2020-01-16 17:36:03 -05:00

70 lines
1.9 KiB
YAML

---
swagger: "2.0"
info:
version: "7.0"
title: phpVMS API
description: All of the responses are contained in the "data" variable
basePath: /api/v1
schemes:
- https
paths:
"/flights/search":
get:
summary: Retrieve all the applications and flags
operationId: getFlightSearch
parameters:
- name: flight_id
in: query
type: string
required: false
description: ID of the flight
- name: airline_id
in: query
type: string
required: false
description: ID of the airline
- name: subfleet_id
in: query
type: string
required: false
description: 'The subfleet to search on. Flights would be returned, but if the subfleets are empty, that means the pilot doesn\'t have permissions for that flight'
- name: flight_number
in: query
type: string
required: false
description: Flight number to use
- name: route_code
in: query
type: string
required: false
description: The route code
- name: dep_icao
in: query
type: string
required: false
description: The departure ICAO
- name: arr_icao
in: query
type: string
required: false
description: The arrival ICAO
- name: dgt
in: query
type: integer
required: false
description: Flights with a distance greater than
- name: dlt
in: query
type: integer
required: false
description: Flights with a distance less than
produces:
- application/json
responses:
200:
description: Returns flights from a search
schema:
$ref: '#/definitions/AppsWrapper'
tags:
- flights