openapi: 3.0.1
info:
  title: Airline Code Lookup air-traffic airport-ontime-prediction API
  description: 'Before using this API, we recommend you read our

    **[Authorization Guide](https://developers.amadeus.com/self-service/apis-docs/guides/authorization-262)**

    for more information on how to generate an access token.


    Please also be aware that our test environment is based on a subset of the production,

    to see what is included in test please refer to our **[data collection](https://github.com/amadeus4dev/data-collection)**.

    '
  version: 1.2.1
  x-status: validated
  x-tags:
  - '#ama-for-dev'
  x-release-note:
    1.2.0:
    - Migration to OAS3
    1.1.0:
    - Correct example
    - Regroup parameter "IATACode" and "ICAOCode" under the same name "airlineCodes"
    1.0.0:
    - initial version
    - List all airlines information (name and code)
    - Introduction of search per IATA or ICAO code
servers:
- url: https://test.api.amadeus.com/v1
tags:
- name: airport-ontime-prediction
paths:
  /airport/predictions/on-time:
    get:
      tags:
      - airport-ontime-prediction
      operationId: getAirportOnTimePrediction
      summary: Amadeus Returns a Percentage of On-time Flight Departures from a Given Airport.
      parameters:
      - name: airportCode
        in: query
        description: airport [IATA code](http://www.iata.org/publications/Pages/code-search.aspx), e.g. BOS for Boston
        required: true
        type: string
        pattern: '[A-Z]{3}'
        x-example: JFK
      - name: date
        in: query
        description: the date on which the traveler will depart from the give airport. Dates are specified in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) YYYY-MM-DD format, e.g. 2019-12-25
        required: true
        type: string
        format: date
        x-example: '2023-11-12'
      responses:
        '200':
          $ref: '#/responses/200'
        '400':
          $ref: '#/responses/400'
        default:
          $ref: '#/responses/500'
      description: ''
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
definitions:
  PredictionResultType:
    description: forecast description
    type: string
    example: 0.8
  Error_400:
    properties:
      errors:
        type: array
        items:
          $ref: '#/definitions/Issue'
    required:
    - errors
    example:
      errors:
      - status: 400
        code: 477
        title: INVALID FORMAT
        detail: invalid query parameter format
        source:
          parameter: airport
          example: CDG
  Error_500:
    properties:
      errors:
        type: array
        items:
          $ref: '#/definitions/Issue'
    required:
    - errors
    example:
      errors:
      - status: 500
        code: 141
        title: SYSTEM ERROR HAS OCCURRED
  Prediction:
    type: object
    properties:
      data:
        $ref: '#/definitions/OnTimePrediction'
      meta:
        $ref: '#/definitions/Meta'
    example:
      data:
        id: JFK20231112
        probability: '0.928'
        result: '0.84062016'
        subType: on-time
        type: prediction
      meta:
        links:
          self: https://test.api.amadeus.com/v1/airport/predictions/on-time?airportCode=JFK&date=2023-11-12
  Meta:
    type: object
    properties:
      links:
        $ref: '#/definitions/Links'
  OnTimePrediction:
    properties:
      type:
        description: the resource name (`prediction`)
        type: string
        example: string-value
      subType:
        type: string
        example: trip-purpose
      id:
        description: item identifier
        type: string
        readOnly: true
        example: '12345'
      result:
        $ref: '#/definitions/PredictionResultType'
      probability:
        description: probability of the forecast (between 0 and 1)
        type: string
        example: string-value
  Links:
    properties:
      self:
        type: string
        format: uri
        example: https://example.com/resource
      related:
        type: string
        format: uri
        example: https://example.com/resource
      type:
        type: string
        example: string-value
  Issue:
    properties:
      status:
        description: the HTTP status code applicable to this error
        type: integer
        example: 1
      code:
        description: an application-specific error code
        type: integer
        format: int64
        example: 1
      title:
        description: a short summary of the error
        type: string
        example: string-value
      detail:
        description: explanation of the error
        type: string
        example: string-value
      source:
        type: object
        title: Issue_Source
        description: an object containing references to the source of the error
        maxProperties: 1
        properties:
          pointer:
            description: a JSON Pointer [RFC6901] to the associated entity in the request document
            type: string
            example: string-value
          parameter:
            description: a string indicating which URI query parameter caused the issue
            type: string
            example: string-value
          example:
            description: a string indicating an example of the right value
            type: string
            example: string-value
responses:
  '400':
    description: "code    | title                                 \n------- | ------------------------------------- \n477     | INVALID FORMAT\n572     | INVALID OPTION\n4926    | INVALID DATA RECEIVED               \n32171   | MANDATORY DATA MISSING \t     \n"
    schema:
      $ref: '#/definitions/Error_400'
  '500':
    description: Unexpected Error
    schema:
      $ref: '#/definitions/Error_500'
  '200':
    description: Success
    schema:
      $ref: '#/definitions/Prediction'