endpoints-routes-v1.0.yml

#####################################################################
# Description: schematics for provided endpoints by the server
# Version: 1.0
#
# Changes:
# 11.09.2018 - file creation. version: 1.0 @Markus Jacobsen
# 13.09.2018 - added endpoint for updating a user. Added more response options for createUser
# 13.09.2018 - added endpoints for uploading a file
# 14.09.2018 - added endpoint for deleting a user and getting a user
# 27.09.2018 - added endpoint for showing a list of tracks
# 27.09.2018 - added endpoint for inserting a track record in DB
# 04.10.2018 - added correct header for /insertTrack + private field
# 05.11.2018 - removed user paths
#####################################################################


/getTracks:
  method: GET
    summary: Get list of IGC tracks
    params:
    - name: token
      type: string
      description: IDToken provided by Firebase Auth
      required: true
    - name: timeSkip
      type: string
      description: Skip to after this timestamp
      required: false (default = 1)
    - name: queryType
      type: string
      description: Type of query to be made
      available: Private, Public
      required: false (default = Public)
    - name: orderDirection
      type: string
      description: Direction of the order
      required: false (default = Asc)
    response:
    - code: 200
      description: List fetched successfully
      content-type: application/json
    - code: 400
      description: bad request, cannot handle the request
      content-type: application/json
    - code: 403
      description: unauthorized, user id cannot be authenticated
      content-type: application/json

/insertTrack:
  method: POST
    header: multipart/form-data
    summary: Upload a IGC file to the server
    params:
    - name: token
      type: string
      description: IDToken provided by Firebase Auth, put in Header
      required: true
    - name: private
      type: boolean, form-data
      description: file private/public
      required: true
    - name: file
      type: string, form-data
      description:
      required: true
    responses:
    - code: 200
      reason: File successfully processed
      content-type: application/json
    - code: 400
      reason: something went wrong in processing the file or no supplied uid
      content-type: application/json
    - code: 415
      reason: File not off correct mime. We only support .IGC
      content-type: application/json

/getTrack:
  method: GET
    summary: Get an IGC file from the server based on TrackID
    params:
    - name: token
      type: string
      description: IDToken provided by Firebase Auth
      required: true
    - name: trackID
      type: string
      description: Track ID to get
      required: true
    response:
    - code: 200
      description: File fetched successfully
      content-type: text/plain
    - code: 400
      description: bad request, cannot handle the request
      content-type: application/json

/deleteTrack:
  method: DELETE
    summary: Deletes an IGC file from the server based on TrackID
    params:
    - name: token
      type: string
      description: IDToken provided by Firebase Auth
      required: true
    - name: trackID
      type: string
      description: Track ID to get
      required: true
    response:
    - code: 200
      description: File deleted successfully
      content-type: text/plain
    - code: 400
      description: bad request, cannot handle the request
      content-type: application/json

/updatePrivacy:
  method: PUT
    summary: Changes privacy setting of TrackID to new setting
    params:
    - name: token
      type: string
      description: IDToken provided by Firebase Auth
      required: true
    - name: trackID
      type: string
      description: Track ID to modify
      required: true
    - name: private
      type: string
      description: true/false
      required: true
    response:
    - code: 200
      description: Privacy updated successfully
      content-type: text/plain
    - code: 400
      description: bad request, cannot handle the request
      content-type: application/json

/takeOwnership:
  method: PUT
    summary: Takes ownership of a trackID that was uploaded by the scraper
    params:
    - name: token
      type: string
      description: IDToken provided by Firebase Auth
      required: true
    - name: trackID
      type: string
      description: Track ID to take ownership of
      required: true
    response:
    - code: 200
      description: Privacy updated successfully
      content-type: text/plain
    - code: 400
      description: bad request, cannot handle the request
      content-type: application/json

/insertTrackPoint:
  method: PUT
    summary: Inserts trackpoint data to a certain track
    params:
    - name: token
      type: string
      description: IDToken provided by Firebase Auth
      required: true
    - name: trackID
      type: string
      description: Track ID to add trackpoints to
      required: true
    - name: trackPoints
      type: json array with models.TrackPoint
      description: Trackpoints to add
      required: true
    response:
    - code: 200
      description: Privacy updated successfully
      content-type: text/plain
    - code: 400
      description: bad request, cannot handle the request
      content-type: application/json