openapi: 3.0.3
info:
  title: VRt.Monitor [MT]
  version: 7.13.2613
  license:
    name: Proprietary
    url: https://veeroute.cn/
  termsOfService: https://veeroute.cn/resources/terms_of_service
  contact:
    name: Veeroute Support Team
    email: servicedesk@veeroute.com
  x-logo:
    url: ../images/monitor.svg
    backgroundColor: '#FAFAFA'
    altText: VRt.Monitor
  description: 'Veeroute Monitor API.


    # Description


    Server part of the Veeroute Monitor.


    ## Entity relationship diagram


    ![erd](../uml/monitor.svg)'
servers:
- url: https://api.edge7.veeroute.cloud
  description: 用于集成和早期访问新功能的环境
- url: https://api.prod7.veeroute.cloud
  description: 生产环境
security:
- ApiKeyAuth: []
tags:
- name: Devices
  description: 'Devices management.

    '
- name: Analytics
  description: 'Analytics and reports.

    '
- name: Waves
  description: 'Waves management.

    '
- name: Trips
  description: 'Trips management.

    '
- name: System
  description: '系统功能。

    所有服务共有的辅助功能。

    '
externalDocs:
  description: 公司网站 Veeroute
  url: https://veeroute.cn/
paths:
  /monitor/trips/{essence_key}:
    get:
      tags:
      - Trips
      summary: Read trip
      description: Getting trip information by key.
      operationId: read_trip
      x-process-type: TRACE
      parameters:
      - $ref: '#/components/parameters/essence_key'
      responses:
        '200':
          description: Successful execution
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/web_trip'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '402':
          $ref: '#/components/responses/402'
        '403':
          $ref: '#/components/responses/403'
        '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'
  /monitor/system/check:
    get:
      tags:
      - System
      summary: 检查服务可用性
      description: 检查服务可用性。
      operationId: check
      x-process-type: NOTRACE
      security: []
      responses:
        '200':
          description: Successful execution
          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'
  /monitor/system/version:
    get:
      tags:
      - System
      summary: 获取服务版本
      description: 获取服务版本。
      operationId: version
      x-process-type: NOTRACE
      security: []
      responses:
        '200':
          description: Successful execution
          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'
  /monitor/file/{filename}:
    get:
      tags:
      - System
      summary: 检查服务可用性
      description: 检查服务可用性。
      operationId: file
      x-process-type: NOTRACE
      security: []
      parameters:
      - $ref: '#/components/parameters/filename'
      responses:
        '200':
          description: Successful execution
          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)

        [JWT 令牌](https://en.wikipedia.org/wiki/JSON_Web_Token) 被使用，

        必须在每个请求的标头中以以下格式指定：


        `授权：承载 <token>`。


        Token 可以通过 VRt.Account API 获取。

        '
      type: http
      scheme: bearer
      bearerFormat: JWT
  schemas:
    basic_essence_key:
      description: Key, unique identifier.
      type: string
      nullable: true
      default: null
      minLength: 1
      maxLength: 1024
      example: key01
    time_window:
      description: Time window.
      type: object
      additionalProperties: false
      nullable: true
      properties:
        from:
          description: Date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
            format.
          type: string
          format: date-time
          example: '2025-03-21T09:30:00+03:00'
        to:
          description: Date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
            format.
          type: string
          format: date-time
          example: '2025-03-21T19:45:00Z'
      required:
      - from
      - to
    assigned_performer:
      description: Performer's shift assigned to the specified time (`shift_time`).
      type: object
      additionalProperties: false
      properties:
        performer_key:
          description: Performer's key, unique identifier.
          type: string
          minLength: 1
          maxLength: 1024
          example: performer0001
        shift_key:
          description: Performer's shift key.
          type: string
          minLength: 1
          maxLength: 1024
          example: performer0001_shift01
        shift_time:
          $ref: '#/components/schemas/time_window'
      required:
      - performer_key
      - shift_key
      - shift_time
    assigned_transport:
      description: Transport's shift assigned to the specified time (`shift_time`).
      type: object
      additionalProperties: false
      properties:
        transport_key:
          description: Transport key, unique identifier.
          type: string
          minLength: 1
          maxLength: 1024
          example: transport001
        shift_key:
          description: Transport's shift key.
          type: string
          minLength: 1
          maxLength: 1024
          example: performer01
        shift_time:
          $ref: '#/components/schemas/time_window'
      required:
      - transport_key
      - shift_key
      - shift_time
    trip_state_flag:
      description: '[Flag of state](#section/Description/Trip-model) inside trip.

        '
      type: string
      enum:
      - AROUND_LOCATION
      - INSIDE_LOCATION
      - INSIDE_LOCATION_WINDOW
      - INSIDE_WORKING_WINDOW
      - INSIDE_EVENT_HARD_WINDOW
      - INSIDE_EVENT_SOFT_WINDOW
      - ON_DEMAND
      - WAITING
      - RELOCATING
      - BREAK
      - REST
      - DEPARTURE
      - ARRIVAL
      - DURING_ROUNDTRIP
      example: RELOCATING
    cargo_action_type:
      description: "Types of actions with cargo:\n  * `ADD` - moving cargo into the\
        \ box\n  * `REMOVE` - moving cargo from the box\n"
      type: string
      enum:
      - ADD
      - REMOVE
      example: ADD
    cargo_action:
      description: Action with a cargo.
      type: object
      additionalProperties: false
      properties:
        box_key:
          description: Box key.
          type: string
          minLength: 1
          maxLength: 1024
          example: box01
        cargo_key:
          description: Cargo key.
          type: string
          minLength: 1
          maxLength: 1024
          example: cargo01
        cargo_action_type:
          $ref: '#/components/schemas/cargo_action_type'
      required:
      - box_key
      - cargo_key
      - cargo_action_type
    cargo_action_list:
      description: List of actions with cargo in transport at the beginning of the
        state.
      type: array
      uniqueItems: false
      minItems: 0
      maxItems: 1000
      items:
        $ref: '#/components/schemas/cargo_action'
    attribute:
      description: Attribute.
      type: object
      additionalProperties: false
      properties:
        key:
          description: Attribute's key.
          type: string
          minLength: 1
          maxLength: 100
          example: code
        value:
          description: Attribute's value.
          type: string
          minLength: 0
          maxLength: 2000
          example: X51
      required:
      - key
      - value
    attributes:
      description: Attributes. Used to add service information.
      type: array
      minItems: 0
      maxItems: 1000
      uniqueItems: true
      default: []
      items:
        $ref: '#/components/schemas/attribute'
    trip_state:
      description: Trip state.
      type: object
      additionalProperties: false
      properties:
        time:
          description: Start time according to the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6).
          type: string
          format: date-time
          example: '2025-03-21T09:30:00+03:00'
        order_key:
          description: Key of the order with which an action is taken.
          type: string
          nullable: true
          default: null
          minLength: 1
          maxLength: 1024
          example: order01
        demand_key:
          description: Key of the demand with which an action is taken.
          type: string
          nullable: true
          default: null
          minLength: 1
          maxLength: 1024
          example: demand01.1
        event_key:
          description: Key of the event at which an action is taken.
          type: string
          nullable: true
          default: null
          minLength: 1
          maxLength: 1024
          example: event01
        location_key:
          description: Key of the location at which an action is taken.
          type: string
          nullable: true
          default: null
          minLength: 1
          maxLength: 1024
          example: location_01
        flags:
          description: "List of flags, describing current state. \n  \nValues of flags\
            \ responsible for geographic location (there can be several flags at the\
            \ same time):\n  * `AROUND_LOCATION` - the performer is near the location\
            \ - in the process of parking or leaving it.\n  * `INSIDE_LOCATION` -\
            \ the performer is at the location.\n\nValues of flags responsible for\
            \ being in time windows (there can be several flags at the same time):\n\
            \  * `INSIDE_WORKING_WINDOW` - the performer is inside the working time\
            \ window.\n  * `INSIDE_LOCATION_WINDOW` - the performer is inside the\
            \ working time of the location.\n  * `INSIDE_EVENT_HARD_WINDOW` - the\
            \ performer is inside the hard time window.\n  * `INSIDE_EVENT_SOFT_WINDOW`\
            \ - the performer is inside the soft time window.\n\nValues of flags responsible\
            \ for actions (there can be only one flag at a time):\n  * `ON_DEMAND`\
            \ - the performer has started working on the request.\n  * `WAITING` -\
            \ the performer has started waiting.\n  * `RELOCATING` - the performer\
            \ has started moving to the next stop.\n  * `BREAK` - the performer has\
            \ started a break.\n  * `REST` - the performer has started a long rest.\n\
            \  * `ARRIVAL` - the performer has started parking.\n  * `DEPARTURE` -\
            \ the performer has finished leaving the parking lot.\n\nThe values of\
            \ the flags responsible for the logical state:\n  * `DURING_ROUNDTRIP`\
            \ - the performer is making a roundtrip.\n"
          type: array
          uniqueItems: true
          minItems: 0
          maxItems: 9
          items:
            $ref: '#/components/schemas/trip_state_flag'
        cargo_actions:
          $ref: '#/components/schemas/cargo_action_list'
        distance:
          description: Cumulative distance from the start of the flight, in meters.
          type: integer
          format: int32
          default: 0
          minimum: 0
          maximum: 4000000000
          example: 5200
        cost:
          description: Cumulative cost calculated based on the performer's and transport
            tariffs.
          type: number
          format: double
          minimum: 0
          maximum: 10000000000
          default: 0
          example: 1231.1
        reward:
          description: Cumulative reward for orders fulfillment.
          type: number
          format: double
          minimum: 0
          maximum: 10000000000
          default: 0
          example: 2343.3
        attributes:
          $ref: '#/components/schemas/attributes'
      required:
      - time
      - flags
    trip_state_list:
      description: List of performer's states.
      type: array
      uniqueItems: false
      minItems: 0
      maxItems: 15001
      items:
        $ref: '#/components/schemas/trip_state'
    trip_waitlist:
      description: 'List of order keys assigned to the performer, but not scheduled
        for a specific time and not taken into account in the transport load.

        '
      type: array
      minItems: 0
      maxItems: 15001
      uniqueItems: true
      items:
        description: Order key.
        type: string
        minLength: 1
        maxLength: 1024
      example:
      - order02
    name:
      description: Name, information field.
      type: string
      minLength: 0
      maxLength: 128
      default: ''
      example: X1-ABC
    trip:
      description: 'A trip is a set of works planned to be performed by a specific
        performer on a specific transport, expressed through a [change in the states](#section/Description/Trip-model)
        of the performer.

        '
      type: object
      additionalProperties: false
      properties:
        key:
          description: Unique trip identifier.
          type: string
          minLength: 1
          maxLength: 1024
          example: trip-0000-9999
        performer:
          $ref: '#/components/schemas/assigned_performer'
        transport:
          $ref: '#/components/schemas/assigned_transport'
        states:
          $ref: '#/components/schemas/trip_state_list'
        waitlist:
          $ref: '#/components/schemas/trip_waitlist'
        name:
          $ref: '#/components/schemas/name'
        attributes:
          $ref: '#/components/schemas/attributes'
      required:
      - key
      - performer
      - transport
      - states
    time_duration:
      description: Time duration according to [ISO 8601 duration](https://en.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
    measurements:
      description: 'Measurements of times and distances for work on location, individual
        trips and planning in general.

        '
      type: object
      additionalProperties: false
      properties:
        time_window:
          $ref: '#/components/schemas/time_window'
        driving_time:
          $ref: '#/components/schemas/time_duration'
        waiting_time:
          $ref: '#/components/schemas/time_duration'
        working_time:
          $ref: '#/components/schemas/time_duration'
        break_time:
          $ref: '#/components/schemas/time_duration'
        rest_time:
          $ref: '#/components/schemas/time_duration'
        arriving_time:
          $ref: '#/components/schemas/time_duration'
        departure_time:
          $ref: '#/components/schemas/time_duration'
        total_time:
          $ref: '#/components/schemas/time_duration'
        distance:
          description: Distance in meters.
          type: integer
          format: int32
          minimum: 0
          maximum: 4000000000
          example: 5200
      required:
      - time_window
      - driving_time
      - waiting_time
      - working_time
      - break_time
      - rest_time
      - arriving_time
      - departure_time
      - total_time
      - distance
    capacity_statistics_sum:
      description: Statistics on capacity characteristics.
      type: object
      additionalProperties: false
      properties:
        mass:
          description: Total weight in kilograms.
          type: number
          format: double
          minimum: 0
          maximum: 1000000000
          example: 105500
        volume:
          description: Total volume in cubic meters.
          type: number
          format: double
          minimum: 0
          maximum: 1000000000
          example: 220034
        capacity_a:
          description: Amount for additional parameter (A) for measuring loads in
            alternative units of measurement.
          type: number
          format: double
          minimum: 0
          maximum: 1000000000
          example: 100000
        capacity_b:
          description: Amount for additional parameter (B) for measuring loads in
            alternative units of measurement.
          type: number
          format: double
          minimum: 0
          maximum: 1000000000
          example: 200000
        capacity_c:
          description: Amount for additional parameter (C) for measuring loads in
            alternative units of measurement.
          type: number
          format: double
          minimum: 0
          maximum: 1000000000
          example: 300000
      required:
      - mass
      - volume
      - capacity_a
      - capacity_b
      - capacity_c
    capacity_statistics_ratio:
      description: Statistics on capacity characteristics (ratio).  It may be more
        than one.
      type: object
      additionalProperties: false
      properties:
        mass:
          description: Loading by mass, in fractions of a unit.
          type: number
          format: double
          minimum: 0
          maximum: 1000
          example: 0.5
        volume:
          description: Loading by volume, in fractions of a unit.
          type: number
          format: double
          minimum: 0
          maximum: 1000
          example: 0.1
        capacity_a:
          description: Loading by additional parameter (A), in fractions of a unit.
          type: number
          format: double
          minimum: 0
          maximum: 1000
          example: 0.7
        capacity_b:
          description: Loading by additional parameter (B), in fractions of a unit.
          type: number
          format: double
          minimum: 0
          maximum: 1000
          example: 0.8
        capacity_c:
          description: Loading by additional parameter (C), in fractions of a unit.
          type: number
          format: double
          minimum: 0
          maximum: 1000
          example: 0.9
      required:
      - mass
      - volume
      - capacity_a
      - capacity_b
      - capacity_c
    capacity_statistics_load:
      description: Statistics on capacity characteristics (ratio). Cannot be greater
        than one.
      type: object
      additionalProperties: false
      properties:
        mass:
          description: Loading by mass, in fractions of a unit.
          type: number
          format: double
          minimum: 0
          maximum: 1
          example: 0.5
        volume:
          description: Loading by volume, in fractions of a unit.
          type: number
          format: double
          minimum: 0
          maximum: 1
          example: 0.1
        capacity_a:
          description: Loading by additional parameter (A), in fractions of a unit.
          type: number
          format: double
          minimum: 0
          maximum: 1
          example: 0.7
        capacity_b:
          description: Loading by additional parameter (B), in fractions of a unit.
          type: number
          format: double
          minimum: 0
          maximum: 1
          example: 0.8
        capacity_c:
          description: Loading by additional parameter (C), in fractions of a unit.
          type: number
          format: double
          minimum: 0
          maximum: 1
          example: 0.9
      required:
      - mass
      - volume
      - capacity_a
      - capacity_b
      - capacity_c
    general_statistics:
      description: Summary statistics for one or a set of trips.
      type: object
      additionalProperties: false
      properties:
        cost:
          description: 'Total cost calculated based on the performer''s and transport
            tariffs.

            '
          type: number
          format: double
          minimum: 0
          maximum: 10000000000
          example: 1231.1
        reward:
          description: The total reward for orders fulfillment.
          type: number
          format: double
          minimum: 0
          maximum: 10000000000
          example: 2343.3
        profit:
          description: 'The total profit is equal to the difference between the total
            reward (`reward`) and cost (`cost`).

            '
          type: number
          format: double
          minimum: -10000000000
          maximum: 10000000000
          example: 1231.1
        measurements:
          $ref: '#/components/schemas/measurements'
          description: "Measurements of times and distances for aggregate and individual\
            \ trips:\n\n  * `time_window` - the start time of the first trip and the\
            \ end time of the last, if there are no trips, the time of the left border\
            \ of the planning horizon is returned, while the from \\ to fields have\
            \ the same value\n  * `driving_time` - duration of driving time\n  * `waiting_time`\
            \ - total waiting time for all locations\n  * `working_time` - total time\
            \ of work execution at all locations included in the trip\n  * `break_time`\
            \ - total break time for all locations\n  * `rest_time` - total rest time\
            \ for all locations\n  * `arriving_time` - total time to drive / park\
            \ at locations\n  * `departure_time` - total time for departure from locations\n\
            \  * `total_time` - total time, composed of `driving_time` + `waiting_time`\
            \ + `working_time` + `break_time` + `rest_time` + `arriving_time` + `departure_time`\n\
            \  * `distance` - the total length of the roundtrip/trip/set of trips,\
            \ in meters\n"
        trips_count:
          description: The total number of planned trips.
          type: integer
          format: int32
          minimum: 0
          maximum: 15001
          example: 250
        performers_count:
          description: The total number of performers involved in orders fulfillment.
          type: integer
          format: int32
          minimum: 0
          maximum: 15001
          example: 157
        orders_count:
          description: The total number of planned and assigned orders.
          type: integer
          format: int32
          minimum: 0
          maximum: 15001
          example: 1700
        plan_orders_count:
          description: The total number of planned orders.
          type: integer
          format: int32
          minimum: 0
          maximum: 15001
          example: 1003
        waitlist_orders_count:
          description: The total number of assigned orders.
          type: integer
          format: int32
          minimum: 0
          maximum: 15001
          example: 697
        stops_count:
          description: The total number of stops (non-unique locations).
          type: integer
          format: int32
          minimum: 0
          maximum: 15001000
          example: 87
        locations_count:
          description: The total number of unique locations within one trip.
          type: integer
          format: int32
          minimum: 0
          maximum: 15001000
          example: 45
        cargo_capacity_sum:
          $ref: '#/components/schemas/capacity_statistics_sum'
          description: Total additive measures of the transported cargo.
        cargo_capacity_ratio:
          $ref: '#/components/schemas/capacity_statistics_ratio'
          description: 'The ratio of the total additive measures of the transported
            cargo to the total capacity of the boxes. In fractions of a unit. It may
            be more than one.

            '
        max_transport_load:
          $ref: '#/components/schemas/capacity_statistics_load'
          description: 'The ratio of the maximum load of boxes to the total capacity
            of boxes. In fractions of a unit. Cannot be greater than one.

            '
        average_speed:
          description: Average speed is the ratio of the total distance to the total
            time of movement, km/h.
          type: number
          format: double
          minimum: 0
          example: 43.1
        round_trips_count:
          description: Number of [roundtrips](#section/Description/Roundtrips) within
            a trip.
          type: integer
          format: int32
          minimum: 0
          maximum: 15001
          example: 2
        average_roundtrip_distance:
          description: Average mileage per roundtrip is the ratio of the total mileage
            per trip to the number of roundtrips, in meters.
          type: number
          format: double
          minimum: 0
          example: 23.4
        average_roundtrip_time:
          $ref: '#/components/schemas/time_duration'
          description: Average roundtrip time is the ratio of the total time to the
            number of roundtrips.
        attributes:
          $ref: '#/components/schemas/attributes'
      required:
      - cost
      - reward
      - profit
      - measurements
      - trips_count
      - performers_count
      - orders_count
      - plan_orders_count
      - waitlist_orders_count
      - stops_count
      - locations_count
      - cargo_capacity_sum
      - cargo_capacity_ratio
      - max_transport_load
      - average_speed
      - round_trips_count
      - average_roundtrip_distance
      - average_roundtrip_time
    transport_load:
      description: Total transport load.
      type: object
      additionalProperties: false
      properties:
        count:
          description: Number of cargos.
          type: integer
          format: int32
          minimum: 0
          maximum: 15001
          example: 1460
        capacity:
          $ref: '#/components/schemas/capacity_statistics_sum'
      required:
      - count
      - capacity
    load_statistics:
      description: 'Statistics for a transport load.

        '
      type: object
      additionalProperties: false
      properties:
        total_load:
          $ref: '#/components/schemas/transport_load'
          description: Total transport load for the entire trip time.
        max_load:
          $ref: '#/components/schemas/transport_load'
          description: Maximum transport load during the entire trip (for each dimension).
        max_transfer_load:
          $ref: '#/components/schemas/transport_load'
          description: Maximum transport load during the driving (for each dimension).
      required:
      - total_load
      - max_load
      - max_transfer_load
    stop_demand:
      description: An demand made for a specific stop.
      type: object
      additionalProperties: false
      properties:
        demand_key:
          description: Demand key.
          type: string
          minLength: 1
          maxLength: 1024
          example: demand_key_01
        event_key:
          description: Event key.
          type: string
          minLength: 1
          maxLength: 1024
          example: event_key_01
        demand_time_window:
          $ref: '#/components/schemas/time_window'
          description: Time window for completing the demand.
      required:
      - demand_key
      - event_key
      - demand_time_window
    stop_statistics:
      description: 'Statistics for a specific stop during a trip.

        '
      type: object
      additionalProperties: false
      properties:
        location_key:
          description: Location key for stop.
          type: string
          minLength: 1
          maxLength: 1024
          example: location_01
        stop_demands:
          description: List of orders completed at this stop.
          type: array
          minItems: 0
          maxItems: 15001
          uniqueItems: false
          items:
            $ref: '#/components/schemas/stop_demand'
        stop_time_window:
          $ref: '#/components/schemas/time_window'
          description: 'Stop time window - from the beginning of the parking lot to
            the complete departure from the location. The window duration is `waiting_time`
            + `working_time` + `break_time` + `rest_time` + `arriving_time` + `departure_time`.

            '
        measurements:
          $ref: '#/components/schemas/measurements'
          description: "Measurements of times and distances for work on location:\n\
            \n  * `time_window` - the time window from the start of movement to the\
            \ stop until the end of the departure from the stop\n  * `driving_time`\
            \ - driving time from the previous stop to the current location\n  * `waiting_time`\
            \ - the duration of waiting for the execution of work at the location\n\
            \  * `working_time` - the time spent on the direct execution of work at\
            \ the location\n  * `break_time` - duration of the performer's break\n\
            \  * `rest_time` - duration of rest for the performer\n  * `arriving_time`\
            \ - the time spent on the entrance/parking at the location\n  * `departure_time`\
            \ - the time taken to leave the location\n  * `total_time` - total time\
            \ for a stop, composed of `driving_time` + `waiting_time` + `working_time`\
            \ + `break_time` + `rest_time` + `arriving_time` + `departure_time`\n\
            \  * `distance` - the distance from the previous stop to the current location\n"
        upload:
          $ref: '#/components/schemas/transport_load'
          description: Loading to the transport at this stop.
        download:
          $ref: '#/components/schemas/transport_load'
          description: Unloading from the transport at this stop.
        max_load:
          $ref: '#/components/schemas/transport_load'
          description: Maximum load of the transport in the process of loading/unloading
            at a stop.
        arrival_load:
          $ref: '#/components/schemas/transport_load'
          description: Transport loading at the time of arrival at this stop.
        departure_load:
          $ref: '#/components/schemas/transport_load'
          description: Transport loading at the moment of departure from this stop.
      required:
      - location_key
      - stop_demands
      - stop_time_window
      - measurements
      - upload
      - download
      - max_load
      - arrival_load
      - departure_load
    stop_statistics_list:
      description: Statistics per stop during the trip
      type: array
      minItems: 0
      maxItems: 15001
      uniqueItems: false
      items:
        $ref: '#/components/schemas/stop_statistics'
    roundtrip_statistics:
      description: 'Statistics for roundtrip.

        '
      type: object
      additionalProperties: false
      properties:
        roundtrip_key:
          description: Roundtrip key.
          type: string
          minLength: 1
          maxLength: 1024
          example: trip_01_round_02
        general_statistics:
          $ref: '#/components/schemas/general_statistics'
          description: General statistics for roundtrip.
      required:
      - roundtrip_key
      - general_statistics
    roundtrip_statistics_list:
      description: Statistics per roundtrip during the trip
      type: array
      minItems: 0
      maxItems: 15001
      uniqueItems: false
      items:
        $ref: '#/components/schemas/roundtrip_statistics'
    trip_statistics:
      description: 'Statistics for a specific trip.

        '
      type: object
      additionalProperties: false
      properties:
        trip_key:
          description: Trip key, unique identifier
          type: string
          minLength: 1
          maxLength: 1024
          example: trip01
        general_statistics:
          $ref: '#/components/schemas/general_statistics'
          description: General statistics for trip.
        load_statistics:
          $ref: '#/components/schemas/load_statistics'
        stop_statistics:
          $ref: '#/components/schemas/stop_statistics_list'
        roundtrip_statistics:
          $ref: '#/components/schemas/roundtrip_statistics_list'
        attributes:
          $ref: '#/components/schemas/attributes'
      required:
      - trip_key
      - general_statistics
      - load_statistics
      - stop_statistics
      - roundtrip_statistics
    basic_enabled:
      description: Using essence for calculations.
      type: boolean
      default: true
      example: false
      readOnly: false
    basic_pristine:
      description: 'A flag indicating whether changes to the entity have been made
        relative to the original data. `true` - means that the data is original and
        has not been changed.

        '
      type: boolean
      default: true
      example: false
      readOnly: true
    basic_time_window:
      description: Time window.
      type: object
      additionalProperties: false
      nullable: true
      properties:
        from:
          description: 'Date and time according to [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6).

            For the left edge of the time window, the earliest of the left edges of
            the child entities'' time windows is selected.

            '
          type: string
          format: date-time
          nullable: true
          example: '2025-03-21T08:45:00+03:00'
        to:
          description: 'Date and time according to [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6).

            For the right edge of the time window, the latest of the right edges of
            the child entities'' time windows is selected.

            '
          type: string
          format: date-time
          nullable: true
          example: '2025-03-21T19:45:00+03:00'
    basic_attributes:
      description: Attributes.
      type: string
      minLength: 0
      maxLength: 1000000
      default: ''
      example: key1:value1, key2:value2
    customfield_datetime:
      description: 'A custom field containing date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
        format. Supported filter type is `DATETIME_RANGE`.

        '
      x-filter-type: DATETIME_RANGE
      type: string
      format: date-time
      nullable: true
      default: null
      example: '2025-03-21T18:00:00+03:00'
    customfield_int:
      description: 'A custom field containing an integer value. Supported filter type
        is `INT_RANGE`.

        '
      x-filter-type: INT_RANGE
      type: integer
      nullable: true
      default: null
      format: int32
      minimum: -10000000000
      maximum: 10000000000
      example: 1
    customfield_float:
      description: 'A custom field containing a floating point value. Supported filter
        type is `FLOAT_RANGE`.

        '
      x-filter-type: FLOAT_RANGE
      type: number
      format: double
      nullable: true
      default: null
      minimum: -10000000000
      maximum: 10000000000
      example: 2343.3
    customfield_duration:
      description: 'A custom field containing the duration of the time period. Supported
        filter type is `DURATION_RANGE`.

        '
      x-filter-type: DURATION_RANGE
      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
    customfield_bool:
      description: 'A custom field containing a boolean value. Supported filter type
        is `BOOL_LIST`.

        '
      x-filter-type: BOOL_LIST
      type: boolean
      nullable: true
      default: null
      example: true
    customfield_string:
      description: 'A custom field containing an string value. Supported filter type
        is `STRING_SEARCH`.

        '
      x-filter-type: STRING_SEARCH
      type: string
      nullable: true
      default: null
      minLength: 1
      maxLength: 2000
      example: value01
    table_customfields:
      description: Custom fields for table.
      type: object
      additionalProperties: false
      properties:
        datetime_1:
          $ref: '#/components/schemas/customfield_datetime'
        datetime_2:
          $ref: '#/components/schemas/customfield_datetime'
        datetime_3:
          $ref: '#/components/schemas/customfield_datetime'
        datetime_4:
          $ref: '#/components/schemas/customfield_datetime'
        datetime_5:
          $ref: '#/components/schemas/customfield_datetime'
        int_1:
          $ref: '#/components/schemas/customfield_int'
        int_2:
          $ref: '#/components/schemas/customfield_int'
        int_3:
          $ref: '#/components/schemas/customfield_int'
        int_4:
          $ref: '#/components/schemas/customfield_int'
        int_5:
          $ref: '#/components/schemas/customfield_int'
        float_1:
          $ref: '#/components/schemas/customfield_float'
        float_2:
          $ref: '#/components/schemas/customfield_float'
        float_3:
          $ref: '#/components/schemas/customfield_float'
        float_4:
          $ref: '#/components/schemas/customfield_float'
        float_5:
          $ref: '#/components/schemas/customfield_float'
        duration_1:
          $ref: '#/components/schemas/customfield_duration'
        duration_2:
          $ref: '#/components/schemas/customfield_duration'
        duration_3:
          $ref: '#/components/schemas/customfield_duration'
        duration_4:
          $ref: '#/components/schemas/customfield_duration'
        duration_5:
          $ref: '#/components/schemas/customfield_duration'
        bool_1:
          $ref: '#/components/schemas/customfield_bool'
        bool_2:
          $ref: '#/components/schemas/customfield_bool'
        bool_3:
          $ref: '#/components/schemas/customfield_bool'
        bool_4:
          $ref: '#/components/schemas/customfield_bool'
        bool_5:
          $ref: '#/components/schemas/customfield_bool'
        string_1:
          $ref: '#/components/schemas/customfield_string'
        string_2:
          $ref: '#/components/schemas/customfield_string'
        string_3:
          $ref: '#/components/schemas/customfield_string'
        string_4:
          $ref: '#/components/schemas/customfield_string'
        string_5:
          $ref: '#/components/schemas/customfield_string'
    table_trip_fields:
      description: Trip\stops fields for table.
      type: object
      additionalProperties: false
      readOnly: true
      properties:
        essence_type:
          description: Essence type.
          type: string
          nullable: false
          enum:
          - TRIP
          - ROUNDTRIP
          default: TRIP
          example: TRIP
        essence_key:
          $ref: '#/components/schemas/basic_essence_key'
          x-filter-type: STRING_SEARCH
          x-default-enabled: true
        enabled:
          $ref: '#/components/schemas/basic_enabled'
          x-filter-type: BOOL_LIST
          x-default-enabled: false
        pristine:
          $ref: '#/components/schemas/basic_pristine'
          x-filter-type: BOOL_LIST
          x-default-enabled: false
        trip_name:
          $ref: '#/components/schemas/name'
          x-filter-type: STRING_SEARCH
          x-default-enabled: true
        cost:
          description: 'Total cost calculated based on the performer''s and transport
            tariffs.

            '
          x-filter-type: FLOAT_RANGE
          x-default-enabled: true
          type: number
          format: double
          minimum: 0
          maximum: 10000000000
          default: 0
          example: 1231.1
        reward:
          description: The total reward for orders fulfillment.
          x-filter-type: FLOAT_RANGE
          x-default-enabled: true
          type: number
          format: double
          minimum: -10000000000
          maximum: 10000000000
          default: 0
          example: 2343.3
        profit:
          description: 'The total profit is equal to the difference between the total
            reward (`reward`) and cost (`cost`).

            '
          x-filter-type: FLOAT_RANGE
          x-default-enabled: true
          type: number
          format: double
          minimum: 0
          maximum: 10000000000
          default: 0
          example: 1231.1
        driving_time:
          $ref: '#/components/schemas/time_duration'
          x-filter-type: DURATION_RANGE
          x-default-enabled: false
        waiting_time:
          $ref: '#/components/schemas/time_duration'
          x-filter-type: DURATION_RANGE
          x-default-enabled: false
        break_time:
          $ref: '#/components/schemas/time_duration'
          x-filter-type: DURATION_RANGE
          x-default-enabled: false
        rest_time:
          $ref: '#/components/schemas/time_duration'
          x-filter-type: DURATION_RANGE
          x-default-enabled: false
        working_time:
          $ref: '#/components/schemas/time_duration'
          x-filter-type: DURATION_RANGE
          x-default-enabled: false
        arriving_time:
          $ref: '#/components/schemas/time_duration'
          x-filter-type: DURATION_RANGE
          x-default-enabled: false
        departure_time:
          $ref: '#/components/schemas/time_duration'
          x-filter-type: DURATION_RANGE
          x-default-enabled: false
        total_time:
          $ref: '#/components/schemas/time_duration'
          x-filter-type: DURATION_RANGE
          x-default-enabled: false
        distance:
          description: Distance in meters.
          x-filter-type: INT_RANGE
          x-default-enabled: false
          type: integer
          format: int32
          minimum: 0
          maximum: 4000000000
          example: 5200
          default: 0
        time_window:
          $ref: '#/components/schemas/basic_time_window'
          x-filter-type: DATETIME_RANGE
          x-default-enabled: true
          x-default-sort-direction: ASC
        orders_count:
          description: The total number of planned and assigned orders.
          x-filter-type: INT_RANGE
          x-default-enabled: false
          type: integer
          format: int32
          minimum: 0
          maximum: 15001
          example: 1700
          default: 0
        plan_orders_count:
          description: The total number of planned orders.
          x-filter-type: INT_RANGE
          x-default-enabled: false
          type: integer
          format: int32
          minimum: 0
          maximum: 15001
          example: 1003
          default: 0
        waitlist_orders_count:
          description: The total number of assigned orders.
          x-filter-type: INT_RANGE
          x-default-enabled: false
          type: integer
          format: int32
          minimum: 0
          maximum: 15001
          example: 697
          default: 0
        stops_count:
          description: The total number of stops (non-unique locations).
          x-filter-type: INT_RANGE
          x-default-enabled: false
          type: integer
          format: int32
          minimum: 0
          maximum: 15001
          example: 87
          default: 0
        locations_count:
          description: The total number of unique locations within one trip.
          x-filter-type: INT_RANGE
          x-default-enabled: false
          type: integer
          format: int32
          minimum: 0
          maximum: 15001
          example: 45
          default: 0
        cargo_capacity_ratio_mass:
          description: The ratio of the total additive measures of the transported
            cargo to the total capacity of the boxes.
          x-filter-type: FLOAT_RANGE
          x-default-enabled: false
          type: number
          format: double
          minimum: 0
          maximum: 1000000
          default: 0
          example: 10
        cargo_capacity_ratio_volume:
          description: The ratio of the total additive measures of the transported
            cargo to the total capacity of the boxes.
          x-filter-type: FLOAT_RANGE
          x-default-enabled: false
          type: number
          format: double
          minimum: 0
          maximum: 1000000
          default: 0
          example: 2
        cargo_capacity_ratio_capacity_a:
          description: The ratio of the total additive measures of the transported
            cargo to the total capacity of the boxes.
          x-filter-type: FLOAT_RANGE
          x-default-enabled: false
          type: number
          format: double
          minimum: 0
          maximum: 1000000
          default: 0
          example: 1
        cargo_capacity_ratio_capacity_b:
          description: The ratio of the total additive measures of the transported
            cargo to the total capacity of the boxes.
          x-filter-type: FLOAT_RANGE
          x-default-enabled: false
          type: number
          format: double
          minimum: 0
          maximum: 1000000
          default: 0
          example: 2
        cargo_capacity_ratio_capacity_c:
          description: The ratio of the total additive measures of the transported
            cargo to the total capacity of the boxes.
          x-filter-type: FLOAT_RANGE
          x-default-enabled: false
          type: number
          format: double
          minimum: 0
          maximum: 1000000
          default: 0
          example: 3
        max_transport_load_mass:
          description: The ratio of the maximum load of boxes to the total capacity
            of boxes.
          x-filter-type: FLOAT_RANGE
          x-default-enabled: false
          type: number
          format: double
          minimum: 0
          maximum: 1000000
          default: 0
          example: 0.1
        max_transport_load_volume:
          description: The ratio of the maximum load of boxes to the total capacity
            of boxes.
          x-filter-type: FLOAT_RANGE
          x-default-enabled: false
          type: number
          format: double
          minimum: 0
          maximum: 1000000
          default: 0
          example: 0.1
        max_transport_load_capacity_a:
          description: The ratio of the maximum load of boxes to the total capacity
            of boxes.
          x-filter-type: FLOAT_RANGE
          x-default-enabled: false
          type: number
          format: double
          minimum: 0
          maximum: 1000000
          default: 0
          example: 0.1
        max_transport_load_capacity_b:
          description: The ratio of the maximum load of boxes to the total capacity
            of boxes.
          x-filter-type: FLOAT_RANGE
          x-default-enabled: false
          type: number
          format: double
          minimum: 0
          maximum: 1000000
          default: 0
          example: 0.1
        max_transport_load_capacity_c:
          description: The ratio of the maximum load of boxes to the total capacity
            of boxes.
          x-filter-type: FLOAT_RANGE
          x-default-enabled: false
          type: number
          format: double
          minimum: 0
          maximum: 1000000
          default: 0
          example: 0.1
        attributes:
          $ref: '#/components/schemas/basic_attributes'
          x-filter-type: STRING_SEARCH
          x-default-enabled: false
        customfields:
          $ref: '#/components/schemas/table_customfields'
    linked_essence:
      description: Link to essence.
      type: object
      additionalProperties: false
      properties:
        essence_key:
          $ref: '#/components/schemas/basic_essence_key'
        essence_type:
          description: Essence type.
          type: string
          nullable: false
          enum:
          - LOCATION
          - ORDER
          - ASSIGNED_ORDER
          - PERFORMER
          - TRANSPORT
          - HARDLINK
          - TRIP
          - FACT
          example: LOCATION
      required:
      - essence_key
      - essence_type
    linked_essence_list:
      description: A list of linked essences.
      type: array
      uniqueItems: false
      minItems: 0
      maxItems: 15001
      items:
        $ref: '#/components/schemas/linked_essence'
    web_trip:
      description: Web Trip.
      type: object
      additionalProperties: false
      properties:
        trip:
          $ref: '#/components/schemas/trip'
        trip_statistics:
          $ref: '#/components/schemas/trip_statistics'
        fields:
          $ref: '#/components/schemas/table_trip_fields'
        linked_essences:
          $ref: '#/components/schemas/linked_essence_list'
      required:
      - trip
      - trip_statistics
    process_code:
      description: 'Unique process identifier. One is created per process, the same
        for different requests for the same process.

        '
      type: string
      format: uuid
      example: 11111111-2222-3333-4444-555555555555
    request_code:
      description: 'Unique identifier of the request. A new one is created for each
        request.

        '
      type: string
      format: uuid
      example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
    user_username:
      description: Unique username for login.
      type: string
      pattern: \w+
      minLength: 2
      maxLength: 256
      example: username_for_login
    company_key:
      description: Unique company key.
      type: string
      pattern: \w+
      minLength: 3
      maxLength: 256
      example: smart_company
    service:
      description: Service name.
      type: string
      enum:
      - UNIVERSAL
      - ROUTING
      - ACCOUNT
      - ADMIN
      - STUDIO
      - MONITOR
      - PACKER
      - AGRO
      example: UNIVERSAL
    operation:
      description: Operation (request) name.
      type: string
      pattern: \w+
      minLength: 3
      maxLength: 256
      example: run_plan_calculation
    tracedata:
      description: Data for request tracing.
      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: Environment identifier.
          type: string
          pattern: \w+
          minLength: 2
          maxLength: 256
          example: edge7
        pod:
          description: Pod identifier.
          type: string
          pattern: \w+
          minLength: 2
          maxLength: 256
          example: 11111111-2222-3333-4444-555555555555
        time:
          description: Date and time service method run in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
            format.
          type: string
          format: date-time
          example: '2025-03-21T09:30:00+03:00'
      required:
      - process_code
      - request_code
      - username
      - company
      - service
      - operation
      - env
      - pod
      - time
    schema_error:
      description: Data error by schema.
      type: object
      additionalProperties: false
      properties:
        entity:
          description: Target entity identifier.
          type: string
          nullable: true
          maxLength: 1024
          example: order_0001
        message:
          description: Error message.
          type: string
          example: bad input data
      required:
      - entity
      - message
    schema_error_list:
      description: List of syntax errors - data does not match the schema.
      type: array
      uniqueItems: false
      minItems: 0
      maxItems: 15001
      items:
        $ref: '#/components/schemas/schema_error'
    general_400:
      description: 400 Error details.
      type: object
      additionalProperties: false
      properties:
        tracedata:
          $ref: '#/components/schemas/tracedata'
        message:
          description: Error details.
          type: string
          nullable: true
          example: Bad Request
        schema_errors:
          $ref: '#/components/schemas/schema_error_list'
      required:
      - tracedata
    general_402:
      description: 402 Error details.
      type: object
      additionalProperties: false
      properties:
        tracedata:
          $ref: '#/components/schemas/tracedata'
        message:
          description: Error details.
          type: string
          nullable: true
          example: Payment Required
      required:
      - tracedata
    general_403:
      description: 403 Error details.
      type: object
      additionalProperties: false
      properties:
        tracedata:
          $ref: '#/components/schemas/tracedata'
        message:
          description: Error details.
          type: string
          nullable: true
          example: Forbidden
      required:
      - tracedata
    general_404:
      description: 404 Error details.
      type: object
      additionalProperties: false
      properties:
        resource_key:
          description: Resource identifier.
          type: string
          nullable: true
          default: null
          example: resource_key
        detail:
          description: Resource details.
          type: object
          additionalProperties: false
          nullable: true
          properties:
            tracedata:
              $ref: '#/components/schemas/tracedata'
          required:
          - tracedata
    general_429:
      description: 429 Error details.
      type: object
      additionalProperties: false
      properties:
        tracedata:
          $ref: '#/components/schemas/tracedata'
        message:
          description: Error details.
          type: string
          nullable: true
          example: Too many requests
      required:
      - tracedata
    general_500:
      description: 500 Error details.
      type: object
      additionalProperties: false
      properties:
        tracedata:
          $ref: '#/components/schemas/tracedata'
        message:
          description: Error details.
          type: string
          nullable: true
          example: Internal Server Error
      required:
      - tracedata
    check_result:
      description: Service availability result.
      type: object
      additionalProperties: false
      properties:
        health:
          description: "The current health indicator of the service.\n  * `0.0` means\
            \ the service is not ready to perform tasks.\n  * `1.0` means the service\
            \ is fully ready to perform tasks.\n"
          type: number
          format: double
          minimum: 0
          maximum: 1
          example: 0.999
      required:
      - health
    version_result:
      description: 服务版本。
      type: object
      additionalProperties: false
      properties:
        major:
          description: '产品版本。

            在单个版本中，保证了服务之间通用数据结构的兼容性。

            版本更改表示与以前版本的产品（和所有服务）不兼容的更改。

            '
          type: integer
          format: int32
          minimum: 1
          maximum: 100
          example: 7
        minor:
          description: '服务的小版本。

            版本更改表示新功能。

            该更新向后兼容服务的主要版本。

            '
          type: integer
          format: int32
          minimum: 0
          maximum: 111
          example: 15
        build:
          description: '构建版本。

            包含向后兼容的错误修复和文档更新。

            '
          type: string
          minLength: 1
          maxLength: 64
          example: 3754RC
      required:
      - major
      - minor
      - build
    file_html:
      description: File with data in [HTML](https://html.spec.whatwg.org/) format.
      type: string
    file_json:
      description: File with data in [JSON](https://www.json.org/) format.
      type: string
  parameters:
    essence_key:
      name: essence_key
      description: Key, unique identifier.
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/basic_essence_key'
    filename:
      name: filename
      description: File name.
      in: path
      required: true
      schema:
        description: File name.
        type: string
        minLength: 6
        maxLength: 128
        example: file_en.html
  responses:
    '400':
      description: Bad request - input data contains errors
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/general_400'
    '401':
      description: Unauthorized - incorrect authorization details, token is missing
        or invalid
    '402':
      description: Payment Required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/general_402'
    '403':
      description: Forbidden - no permission to execute this operation
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/general_403'
    '404':
      description: Not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/general_404'
    '405':
      description: Method not allowed, check method (POST, GET, ...)
    '406':
      description: Client is unable to process a format of response, check headers
    '415':
      description: Unsupported media type, check headers
    '429':
      description: Too many requests
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/general_429'
    '500':
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/general_500'
    '501':
      description: Not implemented
    '502':
      description: Bad gateway
    '503':
      description: Service unavailable
    '504':
      description: Gateway timeout