---
swagger: '2.0'
info:
  version: 1.0.0
  title: Tower Bridge Lifts - API
  description: |

    Provides lift times information, parsed from [towerbridge.org.uk](http://towerbridge.org.uk/lift-times)  
    For more info, please visit the project's [github](https://github.com/aaparmeggiani/tower_bridge_lifts) page.

# host:tower-bridge-lifts.herokuapp.com
basePath: /api/v1
schemes:
  - http
produces:
  - application/json

paths:

  /status:
    get:
      summary: bridge status
      description: Returns the status of the bridge.
      responses:
        200:
          description: successful operation
          schema: 
            $ref: '#/definitions/Status'

  /time:
    get:
      summary: current time 
      description: Current local time in London
      responses:
        200: 
          description: successful operation
          schema:
            type: string

  /lifts:  
    get:
      summary: all scheduled lifts
      description: Return all scheduled lifts filtered by the parameters
      parameters:
        - name: date
          in: query
          description: DD-MM-YY | today | tomorrow
          type: string
          format: date
        - name: count
          in: query
          description: Number of lifts to return. 
          type: integer
          minimum: 0
          maximum: 1000
        - name: group
          in: query
          description: unique times grouped by date 
          type: boolean          
        - name: compact
          in: query
          description: unique times grouped by date 
          type: boolean
  
      responses:
        200:
          description: successful operation
          schema: 
            title: Lifts
            type: array
            items:
              $ref: '#/definitions/Lift'

  /next_lift:
    get:
      summary: the next lift
      description: Returns the next lift only.
      responses:
        200:
          description: successful operation 
          schema:
            $ref: '#/definitions/Lift'

  /bascules:
    get:
      summary: bascules position
      description: Current bascules position [ down | moving_up | up | moving_down ]
      responses:
        200:
          description: successful operation
          schema:
            type: string
            enum:
              - down
              - moving_up
              - up
              - moving_down
    


  /traffic:
    get:
      summary: traffic on the bridge
      description: Current road/foot traffic on the bridge [ allowed |  blocked ]
      responses:
        200: 
          description: successful operation
          schema:
            type: string
            enum:
              - allowed
              - blocked


              
definitions:
  Lift:
    type: object
    properties:
      timestamp: 
        type: string
        example: 2016-01-01T01:02:03
      vessel:
        type: string
        example: Vessel Name
      direction:
        type: string
        enum:
          - up_river
          - down_river
  Status:
    type: object
    properties:
      time:
        type: string
        description: local time
        example: 2016-01-01 01:02:03
      lifts_count: 
        type: number
        description: Number of scheduled lifts
        example: 12
      next_lift:
        type: object
        description: The next lift details
        $ref: '#/definitions/Lift'
      bascules:
        type: string
        description: Current bascules position
        enum:
          - down
          - moving_up
          - up
          - moving_down
      traffic:
        type: string
        description: Current traffic on the bridge
        enum:
          - allowed
          - blocked
      updated:
        type: string
        description: When this info was last updated
        example: 2016-01-01 01:02:03