Mabl Find Model API

openapi: 3.2.0
info:
  title: mabl Find Model API
  description: APIs for interacting with mabl services
  version: 0.599.3.1792436330
  x-readme-id: 62c896636916ce01d2ff4f5a
servers:
- url: /
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: FindModel
paths:
  /findModel/test/{test_id}:
    get:
      tags:
      - FindModel
      summary: Query FindModel by test
      description: Query find models needed for a test
      operationId: getTestFindModels
      parameters:
      - name: test_id
        in: path
        description: The test ID to get find models for
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: environment_id
        in: query
        description: The environment ID to get find models for
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Results of the query
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FindModelQueryResult'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::FindModel
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:
    FindModelQueryResult:
      type: object
      properties:
        findModels:
          type: array
          description: All find models that matched the query
          items:
            $ref: '#/components/schemas/FindModel'
        cursor:
          type: string
          description: Cursor used for pagination
          readOnly: true
      description: The result of a find model query
    AppStateModelAttribute:
      required:
      - attribute_id
      - is_expected
      - stability
      - value_type
      type: object
      properties:
        attribute_id:
          type: string
          description: The canonical ID of this app state attribute
        is_expected:
          type: boolean
          description: Whether a match to the target value or range for this attribute is expected
        stability:
          type: number
          description: Percentage of find runs in which this attribute found value matches the target value or range, stability value inclusive range [0,1]
          format: double
        value_type:
          type: string
          description: The type of value for this attribute
          enum:
          - string
          - number
        recent_values:
          type: array
          description: Most recent values of the attribute (applicable to string type)
          items:
            type: string
        expected_value:
          type:
          - number
          - 'null'
          description: Expected value of the attribute (applicable to number type)
          format: double
        standard_deviation:
          type:
          - number
          - 'null'
          description: Standard deviation of values for this attribute (applicable to number type)
          format: double
        is_value_truncated:
          type: boolean
          description: Whether any of the recent values are truncated (applicable to string type)
        average_target_match_similarity:
          type: number
          description: Average similarity determined by corresponding attribute matcher for target vs found values, similarity value inclusive range [0,1]
          format: double
    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
    FindModel:
      required:
      - created_time
      - digest_count
      - environment_id
      - last_updated_time
      - model_variant_id
      - selector_invariant_id
      - workspace_id
      type: object
      properties:
        model_variant_id:
          type: string
          description: The unique ID of this instance of a FindModel for the indicated selector_invariant_id and environment_id
        workspace_id:
          type: string
          description: The workspace ID for this FindModel and corresponding selector
        selector_invariant_id:
          type: string
          description: The invariant ID of the mabl element selector that this FindModel describes
        environment_id:
          type: string
          description: The environment ID for this FindModel
        exact_phase_timeout_ms:
          type: integer
          description: The amount of time to wait for an exact match in the corresponding find phase before relaxing requirements to a consistent match [milliseconds]
          format: int64
        consistent_phase_timeout_ms:
          type: integer
          description: The amount of time to wait for a consistent match in the corresponding find phase before moving on to auto-healing [milliseconds]
          format: int64
        attributes:
          type: array
          description: Attribute details
          items:
            $ref: '#/components/schemas/FindModelAttribute'
        app_state_attributes:
          type: array
          description: App state attribute details
          items:
            $ref: '#/components/schemas/AppStateModelAttribute'
        latest_digest_id:
          type: string
          description: ID of the most recent FindDigest used to build this model
        latest_digest_time:
          type: integer
          description: Creation time of the most recent FindDigest used to build this model [epoch milliseconds]
          format: int64
        earliest_digest_id:
          type: string
          description: ID of the oldest FindDigest used to build this model
        earliest_digest_time:
          type: integer
          description: Creation time of the oldest FindDigest used to build this model [epoch milliseconds]
          format: int64
        digest_count:
          type: integer
          description: Total number of FindDigests used to build this model
          format: int32
        created_time:
          type: integer
          description: Time at which the FindModel was created [epoch milliseconds]
          format: int64
        last_updated_time:
          type: integer
          description: Time at which the FindModel was last updated [epoch milliseconds]
          format: int64
        model_generation_version:
          type: integer
          description: The version number of the find model generation code used to generate the find model.
          format: int64
    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.'
    FindModelAttribute:
      required:
      - attribute_id
      - differentiation_weight
      - is_expected_consistent_phase
      - is_expected_exact_phase
      - stability
      type: object
      properties:
        attribute_id:
          type: string
          description: The canonical ID of this attribute, equal to attribute_name, if any, otherwise selector_key with "mabl_" prefix
        selector_key:
          type: string
          description: The key identifying this attribute in mabl selectors, if any
        attribute_name:
          type: string
          description: The name of the corresponding element attribute or property, if any
        is_expected_exact_phase:
          type: boolean
          description: Whether a match to the target value for this attribute is expected during the exact match phase
        is_expected_consistent_phase:
          type: boolean
          description: Whether a match to the target value for this attribute is expected during the consistent match phase
        stability:
          type: number
          description: Percentage of find runs in which this attribute found value matches the target, inclusive range [0,1]
          format: double
        differentiation_weight:
          type: number
          description: Weight for this attribute based on its ability to differentiate the correct element from others, inclusive range [0,1]
          format: double
        percent_changes_from_first_found:
          type: number
          description: Percentage of find runs in which the attribute's value sometimes changes between the first time the element is located and the end of the find, inclusive range [0,1]
          format: double
        average_target_match_similarity:
          type: number
          description: Average similarity determined by corresponding attribute matcher for target vs found values, inclusive range [0,1]
          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'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: apiKey
      name: Authorization
      in: header