OneRail Dynamic Routing Config API

openapi: 3.2.0
info:
  version: 1.0.0
  title: OneRail Operation Dashboard Dynamic Routing Config API
  description: Defines Operations Dashboard APIs
  license:
    name: UNLICENSED
    url: ''
servers:
- url: /
  description: Default relative server URL
security:
- bearer: []
tags:
- name: DynamicRoutingConfig
paths:
  /v1/organization/{organizationId}/dynamic-routing-configs:
    parameters:
    - name: organizationId
      in: path
      required: true
      description: organizationId
      schema:
        type: string
    get:
      x-exegesis-controller: DynamicRoutingConfig
      summary: Get organization's Dynamic Routing Configs
      operationId: getAll
      tags:
      - DynamicRoutingConfig
      responses:
        '200':
          description: Dynamic Routing Configurations
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/paths/~1v1~1organization~1%7BorganizationId%7D~1dynamic-routing-configs/put/requestBody/content/application~1json/schema/items'
        '400':
          $ref: '#/paths/~1v1~1routes/get/responses/404'
        '500':
          $ref: '#/paths/~1v1~1routes/get/responses/404'
    put:
      x-exegesis-controller: DynamicRoutingConfig
      summary: Update Dynamic Routing Configurations
      operationId: updateAllDynamicRoutingConfigs
      tags:
      - DynamicRoutingConfig
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  name:
                    type: string
                    description: Name of the dynamic routing config
                  locationId:
                    type: string
                    format: uuid
                  marketId:
                    type:
                    - string
                    - 'null'
                    format: uuid
                  radiusMiles:
                    type:
                    - number
                    - 'null'
                    description: Radius in miles
                  activeAt:
                    type:
                    - string
                    - 'null'
                    format: date-time
                    description: Date when the config becomes active
                  activeUntil:
                    type:
                    - string
                    - 'null'
                    format: date-time
                    description: Date when the config becomes inactive
                  serviceLevelIds:
                    type: array
                    items:
                      type: string
                      format: uuid
                  vehicles:
                    type: array
                    items:
                      type: object
                      required:
                      - userId
                      properties:
                        ownFleetVehicleId:
                          type: string
                          format: uuid
                          description: Own fleet vehicle ID
                        userId:
                          type:
                          - string
                          - 'null'
                          format: uuid
                          description: Driver user ID (optional, can be null)
                  createdAt:
                    type: string
                    format: date-time
                  updatedAt:
                    type: string
                    format: date-time
                  _deleted:
                    type:
                    - boolean
                    - 'null'
                    description: Whether the config is deleted
      responses:
        '200':
          description: Dynamic Routing Configurations updated successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/paths/~1v1~1organization~1%7BorganizationId%7D~1dynamic-routing-configs/put/requestBody/content/application~1json/schema/items'
        '400':
          $ref: '#/paths/~1v1~1routes/get/responses/404'
        '500':
          $ref: '#/paths/~1v1~1routes/get/responses/404'
components:
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: 'Standard JWT bearer token used for authenticated OmniPoint users

        and internal service-to-service calls. Clients send `Authorization: Bearer <jwt>`

        and the token is validated using the shared Core access token secret.

        '
    ApiKey:
      type: apiKey
      in: header
      name: X-ONERAIL-API-KEY
      description: 'Shared secret key used for machine-to-machine integrations. Must be sent

        together with `X-ONERAIL-APP-ID` and is validated against the stored ApiAuth

        record for that application.

        '
    AppId:
      type: apiKey
      in: header
      name: X-ONERAIL-APP-ID
      description: 'Application identifier (UUID) that pairs with `X-ONERAIL-API-KEY` for

        machine-to-machine integrations. Both headers are required for ApiKey-based

        authentication.

        '
    OAuth:
      type: oauth2
      description: 'OAuth 2.0 access token validated by the Operations service (e.g. Okta-backed

        integrations). Clients obtain tokens from their own IdP outside of this API

        and call endpoints with `Authorization: OAuth <access_token>`. The

        `authorizationUrl` and `tokenUrl` values below are placeholders only to

        satisfy the OpenAPI schema; this service does not call them directly and the

        real IdP URLs are configured via environment and introspection logic in code.

        '
      flows:
        authorizationCode:
          authorizationUrl: https://dummy-unused-url.com
          tokenUrl: https://dummy-unused-url.com
          scopes: {}