swagger: '2.0'
info:
  version: 2.0.3
  title: MIP BikeSharing API, GBFS
  description: >-
    This API can be used to receive information about bike sharing/gbfs data.
schemes:
  - https
paths:
  '/vrr-api/rest/bs/site':
    get:
      tags:
        - BikeSharing API
      summary: Find all bike sharing APIs of the MIP.
      description: Find all bike sharing APIs of the MIP.
      security:
        - ApiKey: []
      produces:
        - application/json
      responses:
        '200':
          description: ok
        '400':
          description: Bad Request.
        '401':
          description: Authorization required.
        '404':
          description: Not found.
          
  '/vrr-api/rest/bs/site/{name}/availability':
    get:
      tags:
        - MIP BikeSharing API, GBFS
      summary: Get station information and status information data based on a given api name and optional osm data.
      description: Get station information and status information data based on a given api name and optional osm data.
      security:
        - ApiKey: []
      produces:
        - application/json
      parameters:
        - in: path
          name: name
          type: string
          required: true
          description: the name of the bike sharing API as defined within the MIP
        - in: query
          name: osm
          type: string
          required: false
          description: Optional "OSM" filter - area within which the bike sharing location must be located. Area must be specified by a set of geo locations encoded as string input.<br> longitude and latitude values must be separated by a single semicolon ;  i.e. 13.703963;15.374694<br> coordinates must be separated by two semicolons ;; i.e. 13.703963;15.374694;;13.703984;15.377439<br><br>
            Input Pattern:<br>
            longitude1;latitude1;;longitude2;latitude2;;longitude3;latitude3;;longitude4;lattitude4
            <br><br>
            Example Value<br>
            13.703963;15.374694;;13.703984;15.377439;;13.698338;15.374908;;13.698495;115.37755
      responses:
        '200':
          description: ok
        '400':
          description: Bad Request.
        '401':
          description: Authorization required.
        '404':
          description: Not found.
          
  '/vrr-api/rest/bs/site/all/availability':
    get:
      tags:
        - MIP BikeSharing API, GBFS
      summary: Get station information and status information data optionally based on given osm data.
      description: Get station information and status information data optionally based on given osm data.
      security:
        - ApiKey: []
      produces:
        - application/json
      parameters:
        - in: query
          name: osm
          type: string
          required: false
          description: Optional "OSM" filter - area within which the bike sharing location must be located. Area must be specified by a set of geo locations encoded as string input.<br> longitude and latitude values must be separated by a single semicolon ;  i.e. 13.703963;15.374694<br> coordinates must be separated by two semicolons ;; i.e. 13.703963;15.374694;;13.703984;15.377439<br><br>
            Input Pattern:<br>
            longitude1;latitude1;;longitude2;latitude2;;longitude3;latitude3;;longitude4;lattitude4
            <br><br>
            Example Value<br>
            13.703963;15.374694;;13.703984;15.377439;;13.698338;15.374908;;13.698495;115.37755
      responses:
        '200':
          description: ok
        '400':
          description: Bad Request.
        '401':
          description: Authorization required.
        '404':
          description: Not found.
          
securityDefinitions:
  ApiKey:
    type: apiKey
    name: x-api-key
    in: header