openapi: 3.0.3
info:
  title: VRt.Routing [RT]
  version: 7.6.2491
  license:
    name: Proprietary
    url: https://veeroute.ru/
  termsOfService: https://veeroute.ru/resources/terms_of_service
  contact:
    name: Veeroute Support Team
    email: servicedesk@veeroute.com
  x-logo:
    url: ../images/routing.svg
    backgroundColor: '#FAFAFA'
    altText: VRt.Routing
  description: '# Описание


    Основное назначение **VRt.Routing** - построение пути проезда между точками и
    расчет матриц расстояний и времен.


    ## Возможности


    * Получение расстояния и времени между двумя точками с учетом пробок

    * Построение пути по заданным точкам

    * Построение матрицы расстояний и времен


    ## Диаграмма сущностей


    ![erd](../uml/routing.svg)

    '
servers:
- url: https://api.edge7.veeroute.cloud
  description: Окружение для интеграции и ознакомления с новой функциональностью
- url: https://api.prod7.veeroute.cloud
  description: Основное окружение
security:
- ApiKeyAuth: []
tags:
- name: Route
  description: 'Построение пути передвижения между географическими точками.

    '
- name: Matrix
  description: 'Построение матрицы маршрутизации.


    Для построения матрицы не учитывается параметр `geo_provider`, всегда используется
    гео-провайдер по-умолчанию.

    '
- name: System
  description: 'Системные функции.

    Вспомогательный функционал, общий для всех сервисов.

    '
externalDocs:
  description: Сайт компании Veeroute
  url: https://veeroute.ru/
paths:
  /routing/route/calculation:
    post:
      tags:
      - Route
      summary: Путь между точками
      description: 'Построение пути между точками, учитывая указанный порядок и время
        на каждой остановке. При указании времени выезда `departure_time` учитываются
        пробки.

        '
      operationId: run_route_calculation
      requestBody:
        description: Новый запрос на расчет пути.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/route_task'
            examples:
              RouteTaskMoscow:
                $ref: '#/components/examples/RouteTaskMoscow'
      responses:
        '200':
          description: Путь успешно построен
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/route_result'
              examples:
                RouteResultMoscow:
                  $ref: '#/components/examples/RouteResultMoscow'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '402':
          $ref: '#/components/responses/402'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '415':
          $ref: '#/components/responses/415'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
        '504':
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/503'
      x-codeSamples:
      - lang: Python
        source: "from vrt_lss_routing import *\nfrom vrt_lss_routing.apis import *\n\
          from vrt_lss_routing.models import *\n\n# settings\nHOST = 'https://api.edge7.veeroute.cloud'\
          \ # production env https://api.prod7.veeroute.cloud'\nTOKEN = 'PASTETOKENHERE'\n\
          \n# create client and api instance\nconfiguration = Configuration()\nconfiguration.host\
          \ = HOST\nconfiguration.access_token = TOKEN\nclient = ApiClient(configuration)\n\
          api = RouteApi(client)\n\n# create task\ntask = RouteTask(transport_type=TransportType.CAR,\n\
          \                 waypoints=[\n                     Waypoint(latitude=59.9345,\
          \ longitude=30.1504),\n                     Waypoint(latitude=59.9423, longitude=30.2589),\n\
          \                     Waypoint(latitude=59.9545, longitude=30.2004)]\n \
          \                )\n\n# simple get route\nresponse = api.build_route(task)\n\
          print('answer:', response)\n\n# get route with full http info\nresponse\
          \ = api.build_route(task, _preload_content=False)\nprint('status:', response.status)\n\
          print('answer:', response.data)\nprint('headers:', response.headers)\n"
  /routing/matrix/calculation:
    post:
      tags:
      - Matrix
      summary: Матрица времен и расстояний
      description: 'Построение матриц расстояний и времени попарно между указанными
        точками. Результат работы данного метода может незначительно отличатся от
        метода `route`.

        '
      operationId: run_matrix_calculation
      requestBody:
        description: Новый запрос на расчет матрицы.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/matrix_task'
            examples:
              MatrixTaskMoscow:
                $ref: '#/components/examples/MatrixTaskMoscow'
      responses:
        '200':
          description: Матрица успешно построена
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/matrix_result'
              examples:
                MatrixResultMoscow:
                  $ref: '#/components/examples/MatrixResultMoscow'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '402':
          $ref: '#/components/responses/402'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '415':
          $ref: '#/components/responses/415'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
        '504':
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/503'
  /routing/system/check:
    get:
      tags:
      - System
      summary: Проверка доступности
      description: Проверка доступности сервиса.
      operationId: check
      security: []
      responses:
        '200':
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/check_result'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '415':
          $ref: '#/components/responses/415'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
        '504':
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/503'
  /routing/system/version:
    get:
      tags:
      - System
      summary: Получение версии сервиса
      description: Получение версии сервиса.
      operationId: version
      security: []
      responses:
        '200':
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/version_result'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '415':
          $ref: '#/components/responses/415'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
        '504':
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/503'
  /routing/file/{filename}:
    parameters:
    - $ref: '#/components/parameters/filename_pt'
    get:
      tags:
      - System
      summary: Получение документации
      description: Получение файла с документацией на этот сервис.
      operationId: file
      security: []
      responses:
        '200':
          description: Успешное выполнение
          content:
            text/html:
              schema:
                $ref: '#/components/schemas/file_html'
            text/plain:
              schema:
                $ref: '#/components/schemas/file_json'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '415':
          $ref: '#/components/responses/415'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
        '504':
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/503'
components:
  securitySchemes:
    ApiKeyAuth:
      description: "Для [аутентификации](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication)\
        \ клиента \nиспользуется [JWT токен](https://ru.wikipedia.org/wiki/JSON_Web_Token),\
        \ \nкоторый необходимо указывать в заголовке для каждого запроса в формате:\n\
        \n`Authorization: Bearer <token>`.\n\nУникальный токен для пользовательского\
        \ аккаунта необходимо получить с помощью VRt.Account API.\n"
      type: http
      scheme: bearer
      bearerFormat: JWT
  schemas:
    geopoint:
      description: Географическая точка.
      type: object
      additionalProperties: false
      properties:
        latitude:
          description: Широта в градусах.
          type: number
          format: double
          minimum: -90
          maximum: 90
          example: 55.692789
        longitude:
          description: Долгота в градусах.
          type: number
          format: double
          minimum: -180
          maximum: 180
          example: 37.554554
      required:
      - latitude
      - longitude
    time_duration_null:
      description: Продолжительность временного отрезка в формате [ISO 8601 duration](https://ru.wikipedia.org/wiki/ISO_8601#Durations).
      type: string
      format: duration
      x-custom-format: duration
      pattern: ^P(?!$)((\d+Y)|(\d+\.\d+Y$))?((\d+M)|(\d+\.\d+M$))?((\d+W)|(\d+\.\d+W$))?((\d+D)|(\d+\.\d+D$))?(T(?=\d)((\d+H)|(\d+\.\d+H$))?((\d+M)|(\d+\.\d+M$))?(\d+(\.\d+)?S)?)??$
      minLength: 3
      maxLength: 16
      nullable: true
      default: null
      example: PT2H12M34.3S
    route_waypoint:
      description: 'Точка пути с указанием времени остановки на ней.

        '
      type: object
      additionalProperties: false
      properties:
        geopoint:
          $ref: '#/components/schemas/geopoint'
        name:
          description: 'Название точки. Может использоваться как идентификатор для
            сопоставления задачи и результата расчета.

            '
          type: string
          nullable: true
          default: null
          minLength: 0
          maxLength: 1024
          example: waypoint_1
        duration:
          $ref: '#/components/schemas/time_duration_null'
          description: Время остановки на точке формате [ISO 8601 duration](https://ru.wikipedia.org/wiki/ISO_8601#Durations).
      required:
      - geopoint
    transport_type:
      description: "Типы транспорта:\n  * `CAR` - легковой автомобиль\n  * `TRUCK_1500`\
        \ - грузовой автомобиль с разрешенной массой не более 1500 кг\n  * `TRUCK_3000`\
        \ - грузовой автомобиль с разрешенной массой не более 3000 кг\n  * `TRUCK_5000`\
        \ - грузовой автомобиль с разрешенной массой не более 5000 кг\n  * `TRUCK_10000`\
        \ - грузовой автомобиль с разрешенной массой не более 10000 кг\n  * `TRUCK_20000`\
        \ - грузовой автомобиль с разрешенной массой не более 20000 кг\n  * `TRUCK_10000_L75_H35_W24_6000`\
        \ - грузовой автомобиль с разрешенной массой не более 10000 кг, габаритами\
        \ 7.5 x 3.5 x 2.4 метров, допустимой нагрузкой на ось 6000 кг\n  * `TRUCK_18000_L95_H40_W26_11000`\
        \ - грузовой автомобиль с разрешенной массой не более 18000 кг, габаритами\
        \ 9.5 x 4.0 x 2.6 метров, допустимой нагрузкой на ось 11000 кг\n  * `TRUCK_26000_L120_H40_W26_8000`\
        \ - грузовой автомобиль с разрешенной массой не более 26000 кг, габаритами\
        \ 12.0 x 4.0 x 2.6 метров, допустимой нагрузкой на ось 8000 кг\n  * `TRUCK_GARBAGE_1`\
        \ - грузовой автомобиль для перевозки мусора (тип 1) \n  * `TRUCK_GARBAGE_2`\
        \ - грузовой автомобиль для перевозки мусора (тип 2)\n  * `TUK_TUK` - моторикша\n\
        \  * `BICYCLE` - велосипед\n  * `PEDESTRIAN` - пешеход      \n  * `PUBLIC_TRANSPORT`\
        \ - общественный транспорт\n  * `TELEPORT` - телепорт (мгновенное перемещение\
        \ между точками)\n\nРазрешенная масса - это масса снаряженного транспорта\
        \ с грузом и водителем, установленная предприятием-изготовителем в качестве\
        \ максимально допустимой.\n"
      type: string
      enum:
      - CAR
      - TRUCK_1500
      - TRUCK_3000
      - TRUCK_5000
      - TRUCK_10000
      - TRUCK_20000
      - TRUCK_10000_L75_H35_W24_6000
      - TRUCK_18000_L95_H40_W26_11000
      - TRUCK_26000_L120_H40_W26_8000
      - TRUCK_GARBAGE_1
      - TRUCK_GARBAGE_2
      - TUK_TUK
      - BICYCLE
      - PEDESTRIAN
      - PUBLIC_TRANSPORT
      - TELEPORT
      default: CAR
      example: CAR
    geo_provider:
      description: "Поставщик геоданных:\n  * `VRT` - гео-данные и пробки от Veeroute,\
        \ работают по всему миру.\n\nМожет быть указан специфичный поставщик для определенного\
        \ региона, доступность зависит от настроек клиента.\n"
      type: string
      default: VRT
      minLength: 3
      maxLength: 256
      example: VRT
    geo_settings:
      description: 'Настройки использования гео-данных.

        '
      type: object
      additionalProperties: false
      properties:
        geo_provider:
          $ref: '#/components/schemas/geo_provider'
        toll_roads:
          description: Использовать платные дороги.
          type: boolean
          default: true
          example: false
        ferry_crossing:
          description: Использовать паромные переправы.
          type: boolean
          default: true
          example: false
        traffic_jams:
          description: Учет пробок при планировании маршрутов.
          type: boolean
          default: true
          example: false
        flight_distance:
          description: 'Использовать для расчетов расстояния по прямой. Если указано
            `false` - расстояния рассчитываются по дорогам. При включении данного
            параметра не используется поставщик гео-данных и автоматически выключается
            учет пробок (`traffic_jams`).

            '
          type: boolean
          default: false
          example: true
    timezone:
      description: Временная зона.
      type: integer
      format: int32
      minimum: -12
      maximum: 12
      default: 0
      example: 3
    dataset_name:
      description: 'Название набора данных.

        Техническое поле, не влияющее на расчет.

        '
      type: string
      minLength: 0
      maxLength: 512
      default: ''
      example: custom_dataset_one
    route_task:
      description: 'Задача для построения пути. При указании времени выезда учитываются
        пробки.

        '
      type: object
      additionalProperties: false
      properties:
        waypoints:
          description: Массив географических точек, между которыми нужно проложить
            путь.
          type: array
          minItems: 2
          maxItems: 15001
          uniqueItems: false
          items:
            $ref: '#/components/schemas/route_waypoint'
        transport_type:
          $ref: '#/components/schemas/transport_type'
        geo_settings:
          $ref: '#/components/schemas/geo_settings'
        departure_time:
          description: Дата и время отправления в соответствии с [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6).
          type: string
          format: date-time
          nullable: true
          default: null
          example: '2024-08-21T09:30:00+03:00'
        result_timezone:
          $ref: '#/components/schemas/timezone'
          description: Временная зона, в которой возвращается результат расчета.
        detail:
          description: Построение детального пути - добавляет пути от точек, которые
            не находятся на дорогах, до ближайших дорог.
          type: boolean
          default: false
          example: true
        full_segments:
          description: 'Возвращать полный список сегментов пути. Если опция выключена
            - возвращается краткий список для упрощенного отображения пути.

            '
          type: boolean
          default: true
          example: false
        polyline:
          description: Построение пути перемещения между точками.
          type: boolean
          default: true
          example: false
        trackpoint_time:
          description: Создавать времена у промежуточных точек пути.
          type: boolean
          default: false
          example: true
        dataset_name:
          $ref: '#/components/schemas/dataset_name'
      required:
      - waypoints
    process_code:
      description: 'Уникальный идентификатор процесса. Создается один на процесс,
        одинаковый для разных запросов по одному процессу.

        '
      type: string
      format: uuid
      example: 11111111-2222-3333-4444-555555555555
    request_code:
      description: 'Уникальный идентификатор запроса. Создается новый на каждый запрос.

        '
      type: string
      format: uuid
      example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
    user_username:
      description: Уникальное имя пользователя для авторизации.
      type: string
      pattern: \w+
      minLength: 2
      maxLength: 256
      example: username_for_login
    company_key:
      description: Уникальный идентификатор компании.
      type: string
      pattern: \w+
      minLength: 3
      maxLength: 256
      example: smart_company
    service:
      description: Название сервиса.
      type: string
      enum:
      - UNIVERSAL
      - ROUTING
      - ACCOUNT
      - ADMIN
      - STUDIO
      - MONITOR
      - PACKER
      - AGRO
      example: UNIVERSAL
    operation:
      description: Наименование операции (запроса).
      type: string
      minLength: 3
      maxLength: 256
      example: run_plan_calculation
    tracedata:
      description: Данные используемые для трассировки запросов.
      type: object
      additionalProperties: false
      properties:
        process_code:
          $ref: '#/components/schemas/process_code'
        request_code:
          $ref: '#/components/schemas/request_code'
        username:
          $ref: '#/components/schemas/user_username'
        company:
          $ref: '#/components/schemas/company_key'
        service:
          $ref: '#/components/schemas/service'
        operation:
          $ref: '#/components/schemas/operation'
        env:
          description: Уникальный идентификатор окружения.
          type: string
          pattern: \w+
          minLength: 2
          maxLength: 256
          example: edge7
        pod:
          description: Уникальный идентификатор pod.
          type: string
          pattern: \w+
          minLength: 2
          maxLength: 256
          example: 11111111-2222-3333-4444-555555555555
        time:
          description: Дата и время вызова метода сервиса в соответствии с [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6).
          type: string
          format: date-time
          example: '2024-08-21T09:30:00+03:00'
      required:
      - process_code
      - request_code
      - username
      - company
      - service
      - operation
      - env
      - pod
      - time
    trackpoint:
      description: Географическая точка с привязкой ко времени.
      type: object
      additionalProperties: false
      properties:
        latitude:
          description: Широта в градусах.
          type: number
          format: double
          minimum: -90
          maximum: 90
          example: 55.692789
        longitude:
          description: Долгота в градусах.
          type: number
          format: double
          minimum: -180
          maximum: 180
          example: 37.554554
        time:
          description: Дата и время нахождения в указанной точке в соответствии с
            [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6).
          type: string
          format: date-time
          nullable: true
          default: null
          example: '2024-08-21T09:30:00+03:00'
      required:
      - latitude
      - longitude
    geotrack:
      description: Массив географических точек с привязкой ко времени, между которыми
        построен путь.
      type: array
      minItems: 0
      maxItems: 1000000
      uniqueItems: false
      items:
        $ref: '#/components/schemas/trackpoint'
    route_step:
      description: Шаг отрезка маршрута (отдельный шаг для отдельного вида транспорта).
      type: object
      additionalProperties: false
      properties:
        transport_type:
          $ref: '#/components/schemas/transport_type'
        polyline:
          $ref: '#/components/schemas/geotrack'
      required:
      - transport_type
      - polyline
    time_window:
      description: Временное окно.
      type: object
      additionalProperties: false
      nullable: true
      properties:
        from:
          description: Дата и время в соответствии с [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6).
          type: string
          format: date-time
          example: '2024-08-21T09:30:00+03:00'
        to:
          description: Дата и время в соответствии с [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6).
          type: string
          format: date-time
          example: '2024-08-21T19:45:00Z'
      required:
      - from
      - to
    time_duration:
      description: Продолжительность временного отрезка в формате [ISO 8601 duration](https://ru.wikipedia.org/wiki/ISO_8601#Durations).
      type: string
      format: duration
      x-custom-format: duration
      pattern: ^P(?!$)((\d+Y)|(\d+\.\d+Y$))?((\d+M)|(\d+\.\d+M$))?((\d+W)|(\d+\.\d+W$))?((\d+D)|(\d+\.\d+D$))?(T(?=\d)((\d+H)|(\d+\.\d+H$))?((\d+M)|(\d+\.\d+M$))?(\d+(\.\d+)?S)?)??$
      minLength: 3
      maxLength: 16
      default: PT0S
      example: PT1H45M
    route_statistics:
      description: 'Общая статистика по маршруту.

        '
      type: object
      additionalProperties: false
      properties:
        time_window:
          $ref: '#/components/schemas/time_window'
          description: Временное окно начала и окончания движения.
        distance:
          description: Суммарная протяжённость, в метрах.
          type: integer
          format: int32
          minimum: 0
          maximum: 40000000
          example: 7000
        duration:
          $ref: '#/components/schemas/time_duration'
          description: Время в пути, в формате [ISO 8601 duration](https://ru.wikipedia.org/wiki/ISO_8601#Durations).
        stopping_time:
          $ref: '#/components/schemas/time_duration'
          description: Суммарная продолжительность остановок на точках, в формате
            [ISO 8601 duration](https://ru.wikipedia.org/wiki/ISO_8601#Durations).
      required:
      - time_window
      - distance
      - duration
      - stopping_time
    route_leg:
      description: Отрезок маршрута между двумя точками.
      type: object
      additionalProperties: false
      properties:
        steps:
          description: Шаги, выполнение которых требуется для прохождения отрезка
            маршрута.
          type: array
          uniqueItems: false
          minItems: 0
          maxItems: 16
          items:
            $ref: '#/components/schemas/route_step'
        departure_name:
          description: 'Название точки отправления. Заполняется если задана в исходных
            данных.

            '
          type: string
          nullable: true
          default: null
          minLength: 0
          maxLength: 1024
          example: waypoint_1
        destination_name:
          description: 'Название точки назначения. Заполняется если задана в исходных
            данных.

            '
          type: string
          nullable: true
          default: null
          minLength: 0
          maxLength: 1024
          example: waypoint_2
        statistics:
          $ref: '#/components/schemas/route_statistics'
      required:
      - steps
      - statistics
    route:
      description: Информация о построенном маршруте.
      type: object
      additionalProperties: false
      properties:
        legs:
          description: Отрезки маршрута между точками, указанными в параметре `waypoints`.
          type: array
          uniqueItems: false
          minItems: 0
          maxItems: 10000000
          items:
            $ref: '#/components/schemas/route_leg'
        statistics:
          $ref: '#/components/schemas/route_statistics'
      required:
      - legs
      - statistics
    route_result:
      description: Результат расчета пути.
      type: object
      additionalProperties: false
      properties:
        tracedata:
          $ref: '#/components/schemas/tracedata'
        route:
          $ref: '#/components/schemas/route'
      required:
      - tracedata
      - route
    general_400:
      description: Детализация по ошибке 400.
      type: object
      additionalProperties: false
      properties:
        tracedata:
          $ref: '#/components/schemas/tracedata'
        message:
          description: Сообщение об ошибке.
          type: string
          nullable: true
          example: Bad Request
      required:
      - tracedata
    general_402:
      description: Детализация по ошибке 402.
      type: object
      additionalProperties: false
      properties:
        tracedata:
          $ref: '#/components/schemas/tracedata'
        message:
          description: Сообщение об ошибке.
          type: string
          nullable: true
          example: Payment Required
      required:
      - tracedata
    general_404:
      description: Детализация по ошибке 404.
      type: object
      additionalProperties: false
      properties:
        resource_key:
          description: Идентификатор ресурса.
          type: string
          nullable: true
          default: null
          example: resource_key
        detail:
          description: Детализация по ресурсу.
          type: object
          additionalProperties: false
          nullable: true
          properties:
            tracedata:
              $ref: '#/components/schemas/tracedata'
          required:
          - tracedata
    general_429:
      description: Детализация по ошибке 429.
      type: object
      additionalProperties: false
      properties:
        tracedata:
          $ref: '#/components/schemas/tracedata'
        message:
          description: Сообщение об ошибке.
          type: string
          nullable: true
          example: Too many requests
      required:
      - tracedata
    general_500:
      description: Детализация по ошибке 500.
      type: object
      additionalProperties: false
      properties:
        tracedata:
          $ref: '#/components/schemas/tracedata'
        message:
          description: Сообщение об ошибке.
          type: string
          nullable: true
          example: Internal Server Error
      required:
      - tracedata
    routing_matrix_waypoint:
      description: 'Точка пути в матрице маршрутизации.

        '
      type: object
      additionalProperties: false
      properties:
        geopoint:
          $ref: '#/components/schemas/geopoint'
        name:
          description: 'Название точки. Может использоваться как идентификатор для
            сопоставления задачи и результата расчета.

            '
          type: string
          nullable: true
          default: null
          minLength: 0
          maxLength: 1024
          example: waypoint_1
      required:
      - geopoint
    matrix_task:
      description: Задача для расчета матрицы, при указании времени выезда учитываются
        пробки.
      type: object
      additionalProperties: false
      properties:
        waypoints:
          description: Массив географических точек, между которыми (попарно) нужно
            вычислить расстояния и времена.
          type: array
          minItems: 2
          maxItems: 15001
          uniqueItems: false
          items:
            $ref: '#/components/schemas/routing_matrix_waypoint'
        transport_type:
          $ref: '#/components/schemas/transport_type'
        geo_settings:
          $ref: '#/components/schemas/geo_settings'
        departure_time:
          description: Дата и время отправления в соответствии с [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6).
          type: string
          format: date-time
          nullable: true
          default: null
          example: '2024-08-21T09:30:00+03:00'
        dataset_name:
          $ref: '#/components/schemas/dataset_name'
      required:
      - waypoints
    routing_matrix_line:
      description: Линия значений в матрице расстояний (в метрах) или продолжительностей
        (в секундах) маршрутов между точками.
      type: array
      minItems: 2
      maxItems: 15001
      uniqueItems: false
      items:
        description: 'Расстояние (в метрах) или продолжительность (в секундах) маршрута
          между точками. Отрицательное значение (-1) означает невозможность проезда
          между указанными точками.

          '
        type: integer
        format: int64
        minimum: -1
        maximum: 10000000
        example: 1500
    routing_matrix:
      description: 'Матрица маршрутизации.  Содержит времена и расстояний между точками.

        '
      type: object
      additionalProperties: false
      properties:
        waypoints:
          description: Массив географических точек, между которыми вычислены расстояния
            и времена.
          type: array
          minItems: 2
          maxItems: 15001
          uniqueItems: false
          items:
            $ref: '#/components/schemas/routing_matrix_waypoint'
        distances:
          description: 'Длины маршрутов между точками, в метрах.         Значения
            в массиве упорядочены в соответствии с порядком элементов в параметре
            `waypoints`. Каждая строчка матрицы - массив расстояний из искомой точки
            до каждой другой точки.

            '
          type: array
          minItems: 2
          maxItems: 15001
          uniqueItems: false
          items:
            $ref: '#/components/schemas/routing_matrix_line'
        durations:
          description: 'Массив продолжительностей маршрутов между точками, в секундах.
            Значения в массиве упорядочены в соответствии с порядком элементов в параметре
            `waypoints`. Каждая строчка матрицы - массив времен перемещений из искомой
            точки до каждой другой точки.

            '
          type: array
          minItems: 2
          maxItems: 15001
          uniqueItems: false
          items:
            $ref: '#/components/schemas/routing_matrix_line'
      required:
      - waypoints
      - distances
      - durations
    matrix_result:
      description: Результат расчета матрицы.
      type: object
      additionalProperties: false
      properties:
        tracedata:
          $ref: '#/components/schemas/tracedata'
        matrix:
          $ref: '#/components/schemas/routing_matrix'
      required:
      - tracedata
      - matrix
    check_result:
      description: Результат проверки работоспособности сервиса.
      type: object
      additionalProperties: false
      properties:
        health:
          description: "Текущий показатель здоровья сервиса.      \n  * `0.0` означает\
            \ неготовность сервиса выполнять задачи.      \n  * `1.0` означает полную\
            \ готовность сервиса для выполнения задач.\n"
          type: number
          format: double
          minimum: 0
          maximum: 1
          example: 0.999
      required:
      - health
    version_result:
      description: Версия сервиса.
      type: object
      additionalProperties: false
      properties:
        major:
          description: "Версия продукта.\nВ рамках одной версии гарантируется совместимость\
            \ общих структур данных между сервисами.     \nИзменение версии указывает\
            \ на несовместимые с предыдущими версиями продукта (и, соответственно,\
            \ всех сервисов) изменения.\n"
          type: integer
          format: int32
          minimum: 1
          maximum: 100
          example: 7
        minor:
          description: 'Минорная версия сервиса.

            Изменение версии указывает на новую функциональность.

            Обновление имеет обратную совместимость в рамках мажорной версии сервиса.

            '
          type: integer
          format: int32
          minimum: 0
          maximum: 111
          example: 5
        build:
          description: "Версия сборки.       \nИзменяется при обновлении документации\
            \ и исправлении ошибок.\n"
          type: string
          minLength: 1
          maxLength: 64
          example: 3754RC
      required:
      - major
      - minor
      - build
    file_html:
      description: Файл с данными в формате [HTML](https://html.spec.whatwg.org/).
      type: string
    file_json:
      description: Файл с данными в формате [JSON](https://www.json.org/).
      type: string
  examples:
    RouteTaskMoscow:
      summary: Москва
      value:
        transport_type: CAR
        detail: true
        polyline: true
        waypoints:
        - name: waypoint_01
          duration: PT10M
          geopoint:
            latitude: 55.7464
            longitude: 37.493
        - name: waypoint_02
          duration: PT10M
          geopoint:
            latitude: 55.6044
            longitude: 37.6639
        - name: waypoint_03
          duration: PT10M
          geopoint:
            latitude: 55.7305
            longitude: 37.7387
        - name: waypoint_04
          duration: PT10M
          geopoint:
            latitude: 55.7329
            longitude: 37.6437
        - name: waypoint_05
          duration: PT10M
          geopoint:
            latitude: 55.7974
            longitude: 37.7994
    RouteResultMoscow:
      summary: Москва
      value:
        tracedata:
          process_code: 11111111-2222-3333-4444-555555555555
          request_code: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
          username: example_username
          company: example_company
          env: edge7
          pod: aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee
          service: ROUTING
          operation: run_route_calculation
          time: '2024-08-23T15:38:46.819189Z'
        route:
          legs:
          - steps:
            - transport_type: CAR
              polyline:
              - latitude: 55.746479
                longitude: 37.49293
                time: '2024-08-23T15:42:41Z'
              - latitude: 55.746405
                longitude: 37.492664
                time: '2024-08-23T15:42:42Z'
              - latitude: 55.746625
                longitude: 37.492461
                time: '2024-08-23T15:42:43Z'
            departure_name: waypoint_01
            destination_name: waypoint_02
            statistics:
              distance: 17101
              time_window:
                from: '2024-08-23T17:58:45Z'
                to: '2024-08-23T18:35:45Z'
              duration: PT27M
              stopping_time: PT10M
          statistics:
            distance: 17101
            time_window:
              from: '2024-08-23T17:58:45Z'
              to: '2024-08-23T18:35:45Z'
            duration: PT27M
            stopping_time: PT10M
    MatrixTaskMoscow:
      summary: Москва
      value:
        transport_type: CAR
        waypoints:
        - name: waypoint_01
          geopoint:
            latitude: 55.7464
            longitude: 37.493
        - name: waypoint_02
          geopoint:
            latitude: 55.6044
            longitude: 37.6639
        - name: waypoint_03
          geopoint:
            latitude: 55.7305
            longitude: 37.7387
        - name: waypoint_04
          geopoint:
            latitude: 55.7329
            longitude: 37.6437
        - name: waypoint_05
          geopoint:
            latitude: 55.7974
            longitude: 37.7994
    MatrixResultMoscow:
      summary: Москва
      value:
        tracedata:
          process_code: 11111111-2222-3333-4444-555555555555
          request_code: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
          username: example_username
          company: example_company
          env: edge7
          pod: aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee
          service: ROUTING
          operation: run_matrix_calculation
          time: '2024-08-23T15:42:47.418015Z'
        matrix:
          waypoints:
          - geopoint:
              latitude: 55.7305
              longitude: 37.7387
            name: waypoint_03
          - geopoint:
              latitude: 55.7464
              longitude: 37.493
            name: waypoint_01
          - geopoint:
              latitude: 55.6044
              longitude: 37.6639
            name: waypoint_02
          - geopoint:
              latitude: 55.7974
              longitude: 37.7994
            name: waypoint_05
          - geopoint:
              latitude: 55.7329
              longitude: 37.6437
            name: waypoint_04
          distances:
          - - 0
            - 20315
            - 37877
            - 24153
            - 17333
          - - 29204
            - 0
            - 15069
            - 20098
            - 9181
          - - 36075
            - 15410
            - 0
            - 23216
            - 16063
          - - 25718
            - 23050
            - 24467
            - 0
            - 12455
          - - 17072
            - 6901
            - 16961
            - 13555
            - 0
          durations:
          - - 0
            - 20
            - 28
            - 26
            - 18
          - - 23
            - 0
            - 16
            - 22
            - 9
          - - 27
            - 16
            - 0
            - 25
            - 17
          - - 26
            - 20
            - 24
            - 0
            - 14
          - - 18
            - 7
            - 17
            - 15
            - 0
  responses:
    '400':
      description: Неверный запрос - входные данные содержат ошибки
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/general_400'
    '401':
      description: Ошибка доступа - неверные реквизиты для авторизации, токен отсутствует
        или невалиден
    '402':
      description: Необходима оплата
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/general_402'
    '404':
      description: Запрашиваемая сущность не найдена
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/general_404'
    '405':
      description: Метод запрещен для данного ресурса, проверьте указанный метод (POST,
        GET, ...)
    '406':
      description: Клиент не способен обработать формат ответа, проверьте заголовки
    '415':
      description: Неприемлемый формат запроса, проверьте заголовки
    '429':
      description: Превышено количество запросов
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/general_429'
    '500':
      description: Внутренняя ошибка сервера
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/general_500'
    '501':
      description: Функциональность не доступна для использования
    '502':
      description: Неверный шлюз
    '503':
      description: Сервис не доступен
    '504':
      description: Шлюз не отвечает
  parameters:
    filename_pt:
      name: filename
      description: Название файла.
      in: path
      required: true
      schema:
        description: Название файла.
        type: string
        minLength: 6
        maxLength: 128
        example: file_en.html