Mabl Find Summary API

openapi: 3.2.0
info:
  title: mabl Find Summary API
  description: APIs for interacting with mabl services
  version: 0.599.3.1792436330
  x-readme-id: 62c896636916ce01d2ff4f5a
servers:
- url: /
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: FindSummary
paths:
  /findSummary:
    get:
      tags:
      - FindSummary
      summary: Query FindSummary
      description: Used to query find summary data
      operationId: getTestFindSummaries
      parameters:
      - name: journey_id
        in: query
        description: The Test ID to get find summaries for
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: environment_id
        in: query
        description: The environment ID to get find summaries for
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Results of the query
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FindSummaryQueryResult'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::FindSummary
    post:
      tags:
      - FindSummary
      summary: Create FindSummary
      operationId: createFindSummary
      requestBody:
        description: The FindSummary to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FindSummary'
        required: true
      responses:
        '201':
          description: The FindSummary that was created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FindSummary'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Create::FindSummary
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.
    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
    FindSummaryQueryResult:
      type: object
      properties:
        findsummaries:
          type: array
          description: All find summaries that matched the query nested under their selector id
          items:
            $ref: '#/components/schemas/FindSummarySelectorQueryResult'
        cursor:
          type: string
          description: Cursor used for pagination
          readOnly: true
      description: The result of a find summary query sorted 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.'
    FindSummary:
      required:
      - created_time
      - environment_id
      - selector_id
      type: object
      properties:
        id:
          type: string
          description: The ID of the FindSummary matching it's BQ id. This is the same as the selector override's selector_variant_id.
        selector_id:
          type: string
          description: The ID of the FindSummary's selector id
        environment_id:
          type: string
          description: The environment id that the find strategy ran under
        deployment_id:
          type: string
          description: The deployment id that the find strategy ran under
        journey_id:
          type: string
          description: The journey id that the find strategy ran under
        journey_invariant_id:
          type: string
          description: The journey invariant id that the find strategy ran under
        journey_run_id:
          type: string
          description: The id of the journey run that generated the find summary
        step_id_in_journey:
          type: string
          description: Step id relative to journey
        step_id_in_flow:
          type: string
          description: Step id relative to flow
        step_run_id:
          type: string
          description: The unique id for each time the step is run
        created_time:
          type: integer
          description: Time at which the FindSummary was created
          format: int64
        organization_id:
          type: string
          description: The ID of the organization associated with this FindSummary
        find_strategy_id:
          type: string
          description: The find strategy used
        located_with_properties:
          type: array
          description: The list of properties the element was located with
          items:
            type: string
        locators_candidate_count:
          type: object
          additionalProperties:
            type: integer
            format: int64
          description: The locator candidates and their counts which are expected to match for a correct identification of the element
        found_selector:
          type: string
          description: The selector of the element found using this strategy
        matcher_mismatches:
          type: array
          description: The selector matchers (string id) that did not match between selector used and the element found/chosen, if successful
          items:
            type: string
        matcher_candidate_count:
          type: object
          additionalProperties:
            type: integer
            format: int64
          description: Map from selector matchers (string id) used to number of candidate elements that matched
        matcher_similarity:
          description: Map from selector matchers (string id) used to similarity value (float) between selector used and element found, if successful
        hypothesis_requires_confirmation:
          type: boolean
          description: Whether the element found is a hypothesis requiring confirmation (auto-heal)
        browser:
          type: string
          description: The browser of the find strategy ran in
        emulation_mode:
          type: string
          description: Desktop or mobile web emulation under which the find strategy ran
        device_emulation_id:
          type: string
          description: Device ID with which the find strategy ran
        device_emulation_preset_type:
          type: string
          description: Device preset type with which the find strategy ran
        selector_type:
          type: string
        find_type:
          type: string
        candidate_matches:
          type: integer
          description: The number of candidate matches to the selector found by the final find strategy
          format: int32
        valid_matches:
          type: integer
          description: The number of candidate matches to the selector that were deemed valid by the final find strategy
          format: int32
        find_start_time:
          type: integer
          description: The time when the find action began
          format: int64
        final_strategy_start_time:
          type: integer
          description: The time when the find strategy that generated the result began
          format: int64
        first_found_time:
          type: integer
          description: The time when the found element was first located
          format: int64
        first_found_time_from_start_ms:
          type: integer
          description: Milliseconds since the start of the find action when the found element was first located
          format: int64
        found_score:
          type: number
          description: The score given to the found element by the successful find strategy
          format: double
    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'
    FindSummarySelectorQueryResult:
      type: object
      properties:
        selector_id:
          type: string
          description: The selector ID all the FindSummaries are for
        findsummaries:
          type: array
          description: All find summaries that matched the query for a given selector
          items:
            $ref: '#/components/schemas/FindSummary'
        cursor:
          type: string
          description: Cursor used for pagination
          readOnly: true
      description: The result of a find summary query sorted descending for a specific selector
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: apiKey
      name: Authorization
      in: header