OneRail Market Modifier API

openapi: 3.2.0
info:
  version: 1.0.0
  title: OneRail Operation Dashboard Market Modifier API
  description: Defines Operations Dashboard APIs
  license:
    name: UNLICENSED
    url: ''
servers:
- url: /
  description: Default relative server URL
security:
- bearer: []
tags:
- name: Market Modifier
paths:
  /v1/lp-contract-sla/{lpContractSlaId}/{marketModifierId}/lsp-bias:
    parameters:
    - name: lpContractSlaId
      in: path
      required: true
      schema:
        type: string
    - name: marketModifierId
      in: path
      required: true
      schema:
        type: string
    put:
      x-exegesis-controller: LPContractSla
      summary: Set LSP bias for marketModifier
      operationId: setLSPBias
      tags:
      - Market Modifier
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                lspBias:
                  type: number
                  minimum: 0
                  maximum: 1
                  description: A metric used in the lp-ranking. Higher is better
      responses:
        '200':
          $ref: '#/paths/~1v1~1bulk-dispatch/post/responses/200'
        '400':
          $ref: '#/paths/~1v1~1routes/get/responses/404'
        '404':
          $ref: '#/paths/~1v1~1routes/get/responses/404'
        default:
          $ref: '#/paths/~1v1~1routes/get/responses/404'
  /v1/lp-contract-sla/{lpContractSlaId}/{marketModifierId}/active:
    parameters:
    - name: lpContractSlaId
      in: path
      required: true
      schema:
        type: string
    - name: marketModifierId
      in: path
      required: true
      schema:
        type: string
    put:
      x-exegesis-controller: LPContractSla
      summary: Enable / Disable marketModifier
      operationId: setMarketModifierActive
      tags:
      - Market Modifier
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - active
              properties:
                active:
                  type: boolean
                  description: Indicates the status for marketModifier
      responses:
        '200':
          $ref: '#/paths/~1v1~1bulk-dispatch/post/responses/200'
        '400':
          $ref: '#/paths/~1v1~1routes/get/responses/404'
        '404':
          $ref: '#/paths/~1v1~1routes/get/responses/404'
        default:
          $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: {}