Mabl Mablscript Override API

openapi: 3.2.0
info:
  title: Mablscript Override API
  description: APIs for interacting with mabl services
  version: 0.599.3.1792436330
  x-readme-id: 62c896636916ce01d2ff4f5a
servers:
- url: /
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: MablscriptOverride
paths:
  /selector/overrides/{mablscript_override_id}/rollback/{rollback_time}:
    post:
      tags:
      - MablscriptOverride
      summary: Rollback all selector overrides to a point in time
      description: Used to rollback selector overrides by deleting anything after a timestamp
      operationId: rollbackMablscriptOverride
      parameters:
      - name: mablscript_override_id
        in: path
        description: The id of the mablscript override
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: rollback_time
        in: path
        description: The time to rollback overrides to in epoch time millis. Overrides equal to or before the time will not be rolled back. All others will be deleted
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: The complete MablscriptOverride after the rollback
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MablscriptOverride'
        '400':
          description: Invalid MablscriptOverride was supplied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Restore::MablscriptOverride
  /tests/testScripts/{journey_id}/overrides:
    get:
      tags:
      - MablscriptOverride
      summary: Fetch TestScript Overrides
      description: Retrieves mablscript Overrides for given TestScript and Environment, sorted temporally descending
      operationId: getTestScriptOverrides
      parameters:
      - name: journey_id
        in: path
        description: overridden journey
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: environment_id
        in: query
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: selector_id
        in: query
        description: filter to a specific selector by ID. When provided, skips flow extraction and returns only the override for this selector.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: selector_override_limit
        in: query
        description: number of selector overrides to return (defaults to 100)
        required: false
        style: form
        explode: true
        schema:
          maximum: 100
          minimum: 1
          type: integer
          format: int32
      responses:
        '200':
          description: Array of overrides found for the given request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MablscriptOverrideQueryResult'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: Test run not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::MablscriptOverride
    post:
      tags:
      - MablscriptOverride
      summary: Add Mablscript selector override
      description: Used to add a selector override to an existing mablscript operation
      operationId: createSelectorOverride
      parameters:
      - name: journey_id
        in: path
        description: overridden journey
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: The selector override to set
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SelectorOverrideUpdate'
        required: true
      responses:
        '200':
          description: The complete state of the mablscript override after adding the selector override
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MablscriptOverride'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Create::MablscriptOverride
  /tests/testScripts/overrides/{test_run_id}:
    delete:
      tags:
      - MablscriptOverride
      summary: Rollback All TestScript Overrides
      description: Rollback all selector overrides for a given test run
      operationId: rollbackMablscriptOverridesFromTestRun
      parameters:
      - name: test_run_id
        in: path
        description: overridden test run
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '204':
          description: Rollback of selectors was successful for the given test run
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: User not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Restore::MablscriptOverride
components:
  responses:
    ErrorResponse401:
      description: User not authenticated
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseGeneric'
    ErrorResponse400:
      description: Invalid or missing parameter
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseGeneric'
    ErrorResponse403:
      description: User not authorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseGeneric'
    ErrorResponse:
      description: Unknown error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseGeneric'
  schemas:
    GuardrailApprovalKind:
      type: string
      description: Who decides a guardrail approval. SELF is decided by the person the agent acts for; WORKSPACE, for an agent acting for an API key, by a workspace owner or editor.
      enum:
      - SELF
      - WORKSPACE
    GuardrailRefusal:
      type: object
      properties:
        id:
          type: string
          description: The id of the guardrail policy that decided the refusal.
        reason:
          type: string
          description: Why the policy refuses the request, written for the person the agent acts for.
        decision_id:
          type: string
          description: The id of this decision in the guardrail decision log.
        action:
          type: string
          description: The action the request was evaluated as, written Verb::Resource (for example Delete::Test), as declared by the operation's x-mabl-action extension.
        policy_source:
          type: string
          description: 'Who set the deciding policy: workspace for a rule the workspace''s owners wrote, account for a rule set for the workspace''s account, mabl_agent_type for the agent type''s ceiling, and mabl_default for mabl''s own defaults.'
        approval:
          description: The approval for this request; present when error_code is approval_required and the approval could be recorded. Without it the request cannot be approved.
          allOf:
          - $ref: '#/components/schemas/GuardrailApprovalRef'
      description: The guardrail policy that refused an agent request.
    SelectorOverride:
      required:
      - created_time
      - selector
      type: object
      properties:
        selector_variant_id:
          type: string
          description: Unique ID for this specific override
        journey_invariant_id:
          type: string
        journey_run_id:
          type: string
        step_id_in_journey:
          type: string
        step_run_id:
          type: string
        created_time:
          type: integer
          description: Time the override was created
          format: int64
        selector:
          type: object
          description: Map of string => object
        override_type:
          type: string
          enum:
          - heal
          - update
        browser:
          type: string
        emulation_mode:
          type: string
          description: Desktop or mobile web emulation of run that generated this override
        device_emulation_id:
          type: string
          description: Device ID, if any, used for run that generated this override
        device_emulation_preset_type:
          type: string
          description: Device preset type, if any, used for run that generated this override
        accepted:
          type: boolean
          description: True if the user accepted the override; false if the override was rejected
      description: An override that changes the behavior of a selector in a mablscript
    GuardrailApprovalState:
      type: string
      description: Where a guardrail approval stands. PENDING awaits a decision and expires undecided after 24 hours; APPROVED lets the agent repeat the request, as often as it does, for 20 minutes; DENIED refuses the same request for 20 minutes after the decision, after which asking again opens a new approval; CANCELLED means a person withdrew it while pending or revoked it while approved. EXPIRED and CANCELLED are final.
      enum:
      - PENDING
      - APPROVED
      - DENIED
      - EXPIRED
      - CANCELLED
    MablscriptOverrideQueryResult:
      type: object
      properties:
        overrides:
          type: array
          description: All overrides that matched the query
          items:
            $ref: '#/components/schemas/MablscriptOverride'
      description: The result of a mablscript override query sorted temporally descending
    GuardrailApprovalRef:
      type: object
      properties:
        id:
          type: string
          description: The approval's id.
        state:
          description: Where the approval stands.
          allOf:
          - $ref: '#/components/schemas/GuardrailApprovalState'
        kind:
          description: Who decides the approval.
          allOf:
          - $ref: '#/components/schemas/GuardrailApprovalKind'
        request_expires_time:
          type: integer
          description: When the approval expires if nobody decides it, in epoch milliseconds.
          format: int64
        url:
          type: string
          description: The mabl app page where a person reviews the approval.
      description: 'An approval a guardrail policy asks for. While it is PENDING, stop: give the person the url, tell them the request is waiting for approval, and do not repeat the request or poll in a loop. Once a person tells you it is APPROVED, repeat the identical request with the header X-Mabl-Approval set to id. DENIED means a person said no, so do not work around it.'
    MablscriptOverride:
      required:
      - environment_id
      - id
      - last_updated_time
      - selector_id
      - selector_overrides
      type: object
      properties:
        id:
          type: string
          description: An ID uniquely identifying this override
        environment_id:
          type: string
          description: The ID of the environment associated with this override
        selector_id:
          type: string
          description: The ID of the selector associated with this override
        selector_type:
          type: string
          enum:
          - ancestor
          - target
        find_type:
          type: string
          enum:
          - target_only
          - ancestor_target
        last_updated_time:
          type: integer
          description: Time at which the override was created
          format: int64
        selector_overrides:
          type: array
          description: History of selector overrides where the most recent override is at index 0
          items:
            $ref: '#/components/schemas/SelectorOverride'
      description: An override that changes the behavior of a mablscript operation
      x-implements-interface:
      - HasId
    ErrorResponseGeneric:
      type: object
      properties:
        id:
          type: string
          x-mabl-scope: public
        code:
          maximum: 599
          minimum: 100
          type: integer
          format: int32
          x-mabl-scope: public
        message:
          type: string
          x-mabl-scope: public
        error_code:
          type: string
          description: Machine-readable reason for the error, present only when the API names one. Values are guardrail_blocked (a guardrail policy refused an agent request), approval_required (a guardrail policy requires a person to approve the request first).
        guardrail:
          description: The guardrail policy that refused the request; present only when error_code is guardrail_blocked or approval_required.
          allOf:
          - $ref: '#/components/schemas/GuardrailRefusal'
    SelectorOverrideUpdate:
      required:
      - accepted
      - environment_id
      - selector
      - selector_id
      type: object
      properties:
        selector_variant_id:
          type: string
        selector_id:
          type: string
        environment_id:
          type: string
        journey_run_id:
          type: string
        step_id_in_journey:
          type: string
        step_run_id:
          type: string
        selector:
          type: object
          description: Map of string => object
        accepted:
          type: boolean
          description: True if the user accepted the override; false if the override was rejected
        override_type:
          type: string
        selector_type:
          type: string
        find_type:
          type: string
        browser:
          type: string
        emulation_mode:
          type: string
          description: Desktop or mobile web emulation of run that generated this override
        device_emulation_id:
          type: string
          description: Device ID, if any, used for run that generated this override
        device_emulation_preset_type:
          type: string
          description: Device preset type, if any, used for run that generated this override
      description: Used to pass properties required to add a new selector override
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: apiKey
      name: Authorization
      in: header