API Evangelist conversational phrasing for qTest Manager API Version 3.0 Defect API

# 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 Defect API
  version: 1.0.0
extends: openapi/tricentis-defect-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: 9
- target: $.paths['/api/v3/projects/{projectId}/defects'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a defect
      effect: write
      questions:
      - How do I log a new bug in qTest?
      - Can I submit a defect with attachments in one call?
      instructions:
      - text: Submit a new defect in project {project}.
        slots:
          project: path.projectId
      - text: Log a defect in project {project} with properties {properties}.
        slots:
          project: path.projectId
          properties: requestBody.properties
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/defects/last-change'].get
  update:
    x-apievangelist-phrasing:
      intent: List recently updated defects
      effect: read
      questions:
      - Which defects changed since yesterday?
      - Can I pull defects updated within a time window?
      instructions:
      - text: List defects in project {project} updated since {start}.
        slots:
          project: path.projectId
          start: query.startTime
      - text: Show defects changed between {start} and {end} in project {project}.
        slots:
          project: path.projectId
          start: query.startTime
          end: query.endTime
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/defects/{defectId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a defect
      effect: read
      questions:
      - How do I look up a single defect?
      - What are the current properties of this bug?
      instructions:
      - text: Get defect {defect} in project {project}.
        slots:
          project: path.projectId
          defect: path.defectId
      - text: Show the details of bug {defect}.
        slots:
          defect: path.defectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/defects/{defectId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a defect
      effect: write
      questions:
      - How do I change the status or severity of a defect?
      - Can I update a bug's fields after it's been submitted?
      instructions:
      - text: Update defect {defect} in project {project} with properties {properties}.
        slots:
          project: path.projectId
          defect: path.defectId
          properties: requestBody.properties
      - text: Change the fields on bug {defect}.
        slots:
          defect: path.defectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/defects/{idOrKey}/comments'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on a defect
      effect: read
      questions:
      - What comments are on this defect?
      - Can I page through a bug's discussion thread?
      instructions:
      - text: Show all comments on defect {defect} in project {project}.
        slots:
          project: path.projectId
          defect: path.idOrKey
      - text: List the discussion on bug {defect}.
        slots:
          defect: path.idOrKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/defects/{idOrKey}/comments'].post
  update:
    x-apievangelist-phrasing:
      intent: Comment on a defect
      effect: write
      questions:
      - How do I add a comment to a defect?
      - Can I post reproduction notes on a bug?
      instructions:
      - text: Add the comment {content} to defect {defect} in project {project}.
        slots:
          project: path.projectId
          defect: path.idOrKey
          content: requestBody.content
      - text: 'Post repro notes on bug {defect}: {content}.'
        slots:
          defect: path.idOrKey
          content: requestBody.content
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/defects/{idOrKey}/comments/{commentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one comment on a defect
      effect: read
      questions:
      - How do I fetch a single comment on a defect?
      - Who left a particular comment on a bug?
      instructions:
      - text: Get comment {comment} on defect {defect} in project {project}.
        slots:
          project: path.projectId
          defect: path.idOrKey
          comment: path.commentId
      - text: Show bug comment {comment} on {defect}.
        slots:
          defect: path.idOrKey
          comment: path.commentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/defects/{idOrKey}/comments/{commentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a comment on a defect
      effect: write
      questions:
      - Can I edit a comment on a defect?
      - How do I correct a note on a bug?
      instructions:
      - text: Change comment {comment} on defect {defect} in project {project} to {content}.
        slots:
          project: path.projectId
          defect: path.idOrKey
          comment: path.commentId
          content: requestBody.content
      - text: Edit bug comment {comment} on {defect}.
        slots:
          defect: path.idOrKey
          comment: path.commentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/projects/{projectId}/defects/{idOrKey}/comments/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment from a defect
      effect: destructive
      questions:
      - How do I remove a comment from a defect?
      - Can bug comments be deleted?
      instructions:
      - text: Delete comment {comment} from defect {defect} in project {project}.
        slots:
          project: path.projectId
          defect: path.idOrKey
          comment: path.commentId
      - text: Remove bug comment {comment} on {defect}.
        slots:
          defect: path.idOrKey
          comment: path.commentId
      method: generated
      generated: '2026-10-01'