# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for qTest Manager API Version 3.0 Object Link API
  version: 1.0.0
extends: openapi/tricentis-object-link-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/api/v3/projects/{projectId}/linked-artifacts'].get
  update:
    x-apievangelist-phrasing:
      intent: Get objects linked to given objects
      effect: read
      questions:
      - Which requirements are linked to these test cases?
      - Can I see linked test runs from shared projects too?
      instructions:
      - text: Show what's linked to {type} objects {ids} in project {project}.
        slots:
          type: query.type
          ids: query.ids
          project: path.projectId
      - text: Find the objects associated with {type} pids {pids} in project {project}.
        slots:
          type: query.type
          pids: query.pids
          project: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/{objectType}/{objectId}/link'].post
  update:
    x-apievangelist-phrasing:
      intent: Link objects by ID
      effect: write
      questions:
      - How do I link test cases to a requirement by their IDs?
      - Can I associate several objects with one object at once?
      instructions:
      - text: Link {type} objects to {otype} {object} in project {project}.
        slots:
          project: path.projectId
          otype: path.objectType
          object: path.objectId
          type: query.type
      - text: Associate these {type} IDs with {otype} {object}, project {project}.
        slots:
          project: path.projectId
          otype: path.objectType
          object: path.objectId
          type: query.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/{objectType}/{objectId}/link'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unlink objects by ID
      effect: destructive
      questions:
      - Can I remove the link between a requirement and its test cases using IDs?
      - How do I detach associated objects from an object by ID?
      instructions:
      - text: Unlink {type} objects from {otype} {object} in project {project}.
        slots:
          project: path.projectId
          otype: path.objectType
          object: path.objectId
          type: query.type
      - text: Remove the {type} associations from {otype} {object}, project {project}, by ID.
        slots:
          project: path.projectId
          otype: path.objectType
          object: path.objectId
          type: query.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/{objectType}/{objectId}/{linkType}'].post
  update:
    x-apievangelist-phrasing:
      intent: Link defects to a test step or log by PID
      effect: write
      questions:
      - Can I attach existing defects or Jira defect IDs to a failed test log?
      - Is there a way to link defects to a test step using their PIDs?
      instructions:
      - text: Link {link_type} to {otype} {object} in project {project} by PID.
        slots:
          project: path.projectId
          otype: path.objectType
          object: path.objectId
          link_type: path.linkType
      - text: Attach Jira defect IDs as {link_type} to test log {object} ({otype}) in project {project}.
        slots:
          project: path.projectId
          otype: path.objectType
          object: path.objectId
          link_type: path.linkType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/{objectType}/{objectId}/{linkType}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unlink defects from a test step or log by PID
      effect: destructive
      questions:
      - How do I remove a defect link from a test log using the defect PID?
      - Can I detach defects from a test step by PID?
      instructions:
      - text: Unlink {link_type} from {otype} {object} in project {project} by PID.
        slots:
          project: path.projectId
          otype: path.objectType
          object: path.objectId
          link_type: path.linkType
      - text: Detach the {link_type} PIDs from test step {object} ({otype}), project {project}.
        slots:
          project: path.projectId
          otype: path.objectType
          object: path.objectId
          link_type: path.linkType
      method: generated
      generated: '2026-10-01'