swagger.yml

openapi: 3.0.0
info:
  description: "DEPRECATED: Tracke den Regenbogen-ICE auf seinem Weg durch ganz Deutschland\n\nDEPRECATED!\nDiese Api wird nicht mehr weiter supported, bitten nutze die neue GraphQL Api unter dem Path https://regenbogen-ice.de/graphql."
  title: "RegenbogenICE (DEPRECATED)"
  version: 1.0.0
  contact:
    email: contact@regenbogen-ice.de
  license:
    name: GNU Affero General Public License
    url: https://www.gnu.org/licenses/agpl-3.0.de.html
servers:
  - url: https://regenbogen-ice.de/api

tags:
  - name: "Autocomplete"
    description: "Autocomplete for train vehicles."
  - name: "Train vehicle"
    description: "Get information about a train vehicle."
  - name: "Train trip"
    description: "Get information about a train trip. (e.g. ICE 1565)"
  - name: "Station search"
    description: "Search/autocomplete api for station search."

paths:
  /v1/autocomplete/{q}:
    get:
      operationId: "Autocomplete v1"
      tags: ["Autocomplete"]
      deprecated: true
      parameters:
        - name: "q"
          in: "path"
          required: true
          schema:
            type: string
      responses:
        200:
          description: "Returns list of suggestions sorted by best guess."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AutocompleteV1"
  /v2/autocomplete/{q}:
    get:
      operationId: "Autocomplete v2"
      tags: ["Autocomplete"]
      deprecated: true
      parameters:
        - name: "q"
          in: "path"
          required: true
          schema:
            type: string
        - name: "types"
          in: "query"
          required: false
          schema:
            type: string
            description: "List (seperated by ',') of search types. (train_vehicle, train_trip and coach)."
            default: "train_vehicle,train_trip,coach"
      responses:
        200:
          description: "Returns list of suggestions sorted by best guess."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AutocompleteV2"
  /autocomplete/{q}:
    get:
      deprecated: true
      operationId: "Autocomplete v1 (old path)"
      tags: ["Autocomplete"]
      parameters:
        - name: "q"
          in: "path"
          required: true
          schema:
            type: string
      responses:
        200:
          description: "Returns list of suggestions sorted by best guess."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AutocompleteV1"
  /v1/train_vehicle:
    get:
      operationId: "Train vehicle v1"
      deprecated: true
      tags: ["Train vehicle"]
      parameters:
        - name: "q"
          in: "query"
          required: true
          schema:
            type: string
        - name: "train_type"
          in: "query"
          required: false
          schema:
            type: string
            default: "ICE"
        - name: "coach_sequence_limit"
          in: "query"
          required: false
          description: "If you set coach_sequence_limit to 0 the attribute will be disabled. Set this limit to 1 if you only want to get current coach_sequence."
          schema:
            type: integer
            default: 0
        - name: "include_coaches"
          in: "query"
          required: false
          schema:
            type: boolean
            default: true
        - name: "trip_limit"
          in: "query"
          required: false
          description: "If you set trip_limit to 0 the attribute will be disabled."
          schema:
            type: integer
            default: 0
        - name: "include_routes"
          in: "query"
          required: false
          schema:
            type: boolean
            default: true
        - name: "include_marudor_link"
          in: "query"
          required: false
          schema:
            type: boolean
            default: false
      responses:
        200:
          description: "Returns information about train vehicle."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TrainVehicle"
        404:
          description: "Train vehicle doesn't exist."
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: "Error text"
                    example: "Train vehicle doesn't exist."
  /v1/train_trip:
    get:
      operationId: "Train trip v1"
      tags: ["Train trip"]
      deprecated: true
      parameters:
        - name: "train_number"
          in: "query"
          required: true
          schema:
            type: integer
        - name: "train_type"
          in: "query"
          required: false
          schema:
            type: string
            default: "ICE"
        - name: "trip_limit"
          in: "query"
          required: false
          schema:
            type: integer
            default: 1
        - name: "include_marudor_link"
          in: "query"
          required: false
          schema:
            type: boolean
            default: false
        - name: "include_routes"
          in: "query"
          required: false
          schema:
            type: boolean
            default: true
        - name: "include_train_vehicle"
          in: "query"
          required: false
          schema:
            type: boolean
            default: true
        - name: "coach_sequence_limit"
          in: "query"
          required: false
          schema:
            type: integer
            default: 0
        - name: "include_coaches"
          in: "query"
          required: false
          schema:
            type: boolean
            default: true
      responses:
        200:
          description: "List of train trips ordered by departure (desc)."
          content:
            application/json:
              schema:
                description: Ordered by initial_departure (descending).
                type: array
                items:
                  $ref: "#/components/schemas/TrainTrip"
        404:
          description: "Train trip doesn't exist."
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: "Error text"
                    example: "Train trip doesn't exist."
  /train_vehicle:
    get:
      deprecated: true
      operationId: "Train vehicle v1 (old path)"
      tags: ["Train vehicle"]
      parameters:
        - name: "q"
          in: "query"
          required: true
          schema:
            type: string
        - name: "train_type"
          in: "query"
          required: false
          schema:
            type: string
            default: "ICE"
        - name: "coach_sequence_limit"
          in: "query"
          required: false
          description: "If you set coach_sequence_limit to 0 the attribute will be disabled. Set this limit to 1 if you only want to get current coach_sequence."
          schema:
            type: integer
            default: 0
        - name: "include_coaches"
          in: "query"
          required: false
          schema:
            type: boolean
            default: true
        - name: "trip_limit"
          in: "query"
          required: false
          description: "If you set trip_limit to 0 the attribute will be disabled."
          schema:
            type: integer
            default: 0
        - name: "include_routes"
          in: "query"
          required: false
          schema:
            type: boolean
            default: true
        - name: "include_marudor_link"
          in: "query"
          required: false
          schema:
            type: boolean
            default: false
      responses:
        200:
          description: "Returns information about train vehicle."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TrainVehicle"
        404:
          description: "Train vehicle doesn't exist."
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: "Error text"
                    example: "Train vehicle doesn't exist."
  /v1/station_search/{q}:
    get:
      deprecated: true
      operationId: "Station search v1"
      tags: ["Station search"]
      parameters:
        - name: "q"
          in: "path"
          required: true
          schema:
            type: string
        - name: "length"
          in: "query"
          required: false
          schema:
            type: number
            default: 5
      responses:
        200:
          description: "Returns list of long distance trains stations."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/StationSearch"
  /stationSearch/{q}:
    get:
      deprecated: true
      operationId: "Station search v1 (old path)"
      tags: ["Station search"]
      parameters:
        - name: "q"
          in: "path"
          required: true
          schema:
            type: string
        - name: "length"
          in: "query"
          required: false
          schema:
            type: number
            default: 5
      responses:
        200:
          description: "Returns list of long distance trains stations."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/StationSearch"
components:
  schemas:
    AutocompleteV1:
      type: "array"
      items:
        type: string
    AutocompleteV2:
      type: "array"
      items:
        type: "object"
        properties: 
          guess:
            type: "string"
          train_type:
            type: "string"
            description: "The train type. (e.g. ICE or IC)"
            example: "ICE"
          type:
            type: "string"
            description: "The type of object. (train_vehicle, train_trip or coach)"
            example: "train_vehicle"
    TrainTripStop:
      type: object
      properties:
        cancelled:
          type: integer
          description: "1 or 0 as boolean"
        station:
          type: string
          example: "Düsseldorf Hbf"
        scheduled_departure:
          type: string
          format: date-time
          nullable: true
        departure:
          type: string
          format: date-time
          nullable: true
        scheduled_arrival:
          type: string
          format: date-time
          nullable: true
        arrival:
          type: string
          format: date-time
          nullable: true
    TrainTrip:
      type: object
      properties:
        group_index:
          type: integer
          deprecated: true
        train_number:
          type: integer
        train_type:
          type: string
        origin_station:
          type: string
          nullable: true
        destination_station:
          type: string
          nullable: true
        initial_departure:
          type: string
          format: date-time
        trip_timestamp:
          type: string
          format: date-time
        vehicle_timestamp:
          type: string
          format: date-time
        marudor:
          type: string
          description: "Marudor link to train trip. Enable by setting include_marudor_link to true. This value can be null. (e.g. IC's [except IC2])"
        train_vehicle:
          description: "Not available at train_vehicle endpoint. Enable this attribute by setting include_train_vehicle to true."
          $ref: "#/components/schemas/TrainVehicle"
          nullable: true
        stops:
          type: array
          items:
            $ref: "#/components/schemas/TrainTripStop"
          description: "Enable this attribute by setting include_routes to true."
    TrainCoach:
      type: "object"
      properties:
        index:
          type: integer
        class:
          type: integer
        type:
          type: string
          example: "Bpmbz"
        uic:
          type: string
        category:
          type: string
          example: "REISEZUGWAGENZWEITEKLASSE"

    TrainCoachSequence:
      type: "object"
      properties:
        timestamp:
          type: string
          format: date-format
        coaches:
          type: array
          items:
            $ref: "#/components/schemas/TrainCoach"
          description: Enable coaches by setting include_coaches to true.
    TrainVehicle:
      type: "object"
      properties:
        building_series:
          type: integer
          nullable: true
        name:
          type: string
          nullable: true
        number:
          type: integer
        train_type:
          type: string
        trips:
          type: array
          description: Set trip_limit to limit trips. Ordered by initial_departure (descending).
          items:
            $ref: "#/components/schemas/TrainTrip"
        coach_sequences:
          type: array
          description: Set coach_sequence_limit to limit coach_sequences.
          items:
            $ref: "#/components/schemas/TrainCoachSequence"
    StationSearch:
      type: "array"
      items:
        type: "object"
        properties:
          evaNumber:
            type: number
          name:
            type: string