# 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 Session API
  version: 1.0.0
extends: openapi/tricentis-v3-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['/api/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['/api/sessions/batch'].put
  update:
    x-apievangelist-phrasing:
      intent: Update several sessions at once
      effect: write
      questions:
      - Can I update many exploratory sessions in a single request?
      - Is there a batch edit for sessions?
      instructions:
      - text: Batch update the selected sessions.
      - text: Apply the same edit to multiple sessions in one call.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sessions/batch'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several sessions at once
      effect: destructive
      questions:
      - Can I delete a batch of exploratory sessions together?
      - Is there a bulk delete for sessions?
      instructions:
      - text: Batch delete the selected sessions.
      - text: Remove multiple exploratory sessions in one request.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/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['/api/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['/api/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['/api/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['/api/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'