# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for qTest Explorer | Sessions V3 Coverage API
  version: 1.0.0
extends: openapi/tricentis-v3-coverage-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: 6
- target: $.paths['/api/sessions/{sessionId}/coverages'].get
  update:
    x-apievangelist-phrasing:
      intent: List a session's coverages
      effect: read
      questions:
      - Which requirements or test objects does an exploratory session cover?
      - Can I list everything a session is linked to as coverage?
      instructions:
      - text: List the coverages of session {session}.
        slots:
          session: path.sessionId
      - text: Show what session {session} covers.
        slots:
          session: path.sessionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sessions/{sessionId}/coverages'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace all coverages of a session
      effect: write
      questions:
      - Can I reset the full coverage list of a session in one call?
      - Is there a bulk update for every coverage on a session?
      instructions:
      - text: Replace all coverages of session {session} with {coverages}.
        slots:
          session: path.sessionId
          coverages: requestBody.coverages
      - text: Overwrite the coverage list on session {session}.
        slots:
          session: path.sessionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sessions/{sessionId}/coverages'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a coverage to a session
      effect: write
      questions:
      - How do I link a session to a requirement it covers?
      - Can I add an external object as coverage for a session?
      instructions:
      - text: Add coverage {title} to session {session}.
        slots:
          title: requestBody.title
          session: path.sessionId
      - text: Link session {session} to external object {ext_id} of type {type}.
        slots:
          session: path.sessionId
          ext_id: requestBody.ext_id
          type: requestBody.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sessions/{sessionId}/coverages/{coverageId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one session coverage
      effect: read
      questions:
      - Can I read a single coverage link of a session?
      - What external object does one coverage point to?
      instructions:
      - text: Get coverage {coverage} of session {session}.
        slots:
          coverage: path.coverageId
          session: path.sessionId
      - text: Show the details of coverage {coverage} in session {session}.
        slots:
          coverage: path.coverageId
          session: path.sessionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sessions/{sessionId}/coverages/{coverageId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update one session coverage
      effect: write
      questions:
      - Can I change the title or order of one coverage on a session?
      - How do I edit a single coverage link?
      instructions:
      - text: Rename coverage {coverage} of session {session} to {title}.
        slots:
          coverage: path.coverageId
          session: path.sessionId
          title: requestBody.title
      - text: Set the order of coverage {coverage} in session {session} to {order}.
        slots:
          coverage: path.coverageId
          session: path.sessionId
          order: requestBody.order
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sessions/{sessionId}/coverages/{coverageId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a coverage from a session
      effect: destructive
      questions:
      - How do I unlink a requirement a session no longer covers?
      - Can I delete one coverage from a session?
      instructions:
      - text: Delete coverage {coverage} from session {session}.
        slots:
          coverage: path.coverageId
          session: path.sessionId
      - text: Unlink coverage {coverage} of session {session}.
        slots:
          coverage: path.coverageId
          session: path.sessionId
      method: generated
      generated: '2026-10-01'