# 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 V2 Session API
  version: 1.0.0
extends: openapi/tricentis-v2-session-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: 8
- target: $.paths['/sessions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an exploratory testing session
      effect: write
      questions:
      - How do I start a new exploratory testing session in a project?
      - Can I set a test charter and objectives on a new session?
      instructions:
      - text: Create session {title} in project {project}.
        slots:
          title: requestBody.title
          project: requestBody.project_id
      - text: Create session {title} in {project} with charter {charter}.
        slots:
          title: requestBody.title
          project: requestBody.project_id
          charter: requestBody.test_charter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sessions/{sessionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an exploratory session
      effect: read
      questions:
      - Can I read a session together with its timeline and app info?
      - What details are stored on one exploratory session?
      instructions:
      - text: Get session {session}.
        slots:
          session: path.sessionId
      - text: Get session {session} including {include}.
        slots:
          session: path.sessionId
          include: query.include
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sessions/{sessionId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an exploratory session
      effect: write
      questions:
      - How do I change a session's title or summary?
      - Can I reassign a session to another tester?
      instructions:
      - text: Rename session {session} to {title}.
        slots:
          session: path.sessionId
          title: requestBody.title
      - text: Assign session {session} to {user}.
        slots:
          session: path.sessionId
          user: requestBody.assigned_user
      - text: Set the overall summary of session {session} to {summary}.
        slots:
          session: path.sessionId
          summary: requestBody.overall_summary
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sessions/{sessionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an exploratory session
      effect: destructive
      questions:
      - How do I delete one exploratory session?
      - Can I remove a single session by id?
      instructions:
      - text: Delete session {session}.
        slots:
          session: path.sessionId
      - text: Remove exploratory session {session} permanently.
        slots:
          session: path.sessionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sessions/{sessionId}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an exploratory session's status
      effect: read
      questions:
      - What state is an exploratory session in right now?
      - Is my session still in progress?
      instructions:
      - text: Get the status of session {session}.
        slots:
          session: path.sessionId
      - text: Check whether session {session} is finished.
        slots:
          session: path.sessionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sessions/{sessionId}/status'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an exploratory session's status
      effect: write
      questions:
      - How do I mark an exploratory session as complete?
      - Can I change only the status of a session?
      instructions:
      - text: Set session {session} to status {status}.
        slots:
          session: path.sessionId
          status: requestBody.status
      - text: Change the state of session {session} to {status}.
        slots:
          session: path.sessionId
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/coverages/sessions'].get
  update:
    x-apievangelist-phrasing:
      intent: Find sessions linked to a qTest Manager object
      effect: read
      questions:
      - Which exploratory sessions cover a given requirement or test case?
      - Can I find sessions by the external object they are linked to?
      instructions:
      - text: Find sessions covering {type} {ext_id} from {publisher} in project {project}.
        slots:
          type: query.type
          ext_id: query.extId
          publisher: query.publisherName
          project: query.projectId
      - text: List the sessions linked to object {ext_id} of type {type} in project {project}, publisher {publisher}.
        slots:
          ext_id: query.extId
          type: query.type
          project: query.projectId
          publisher: query.publisherName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sessions/{sessionId}/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an exploratory session's history
      effect: read
      questions:
      - Who changed an exploratory session and when?
      - Can I see the edit history of a session?
      instructions:
      - text: Get the history of session {session}.
        slots:
          session: path.sessionId
      - text: Show every recorded change to session {session}.
        slots:
          session: path.sessionId
      method: generated
      generated: '2026-10-01'