# 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 Screen API
  version: 1.0.0
extends: openapi/tricentis-v3-screen-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: 11
- target: $.paths['/api/sessions/{sessionId}/screens'].get
  update:
    x-apievangelist-phrasing:
      intent: List a session's screens
      effect: read
      questions:
      - Which screens were captured during an exploratory session?
      - Can I list every screenshot step of a session?
      instructions:
      - text: List the screens of session {session}.
        slots:
          session: path.sessionId
      - text: Show all captured screens in session {session}.
        slots:
          session: path.sessionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sessions/{sessionId}/screens'].put
  update:
    x-apievangelist-phrasing:
      intent: Update several screens at once
      effect: write
      questions:
      - Can I update many captured screens of a session in one request?
      - Is there a bulk edit for session screens?
      instructions:
      - text: Update multiple screens in session {session}.
        slots:
          session: path.sessionId
      - text: Bulk edit the captured screens of session {session}.
        slots:
          session: path.sessionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sessions/{sessionId}/screens'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a screen to a session
      effect: write
      questions:
      - How do I add a new captured screen to a session?
      - Can I add annotations when creating a screen?
      instructions:
      - text: Add screen {title} to session {session}.
        slots:
          title: requestBody.title
          session: path.sessionId
      - text: Create a screen in session {session} with annotations {annotations}.
        slots:
          session: path.sessionId
          annotations: requestBody.annotations
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sessions/{sessionId}/screens/{screenId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a session screen
      effect: read
      questions:
      - Can I read the details of one captured screen?
      - What title and timestamp does a given screen have?
      instructions:
      - text: Get screen {screen} of session {session}.
        slots:
          screen: path.screenId
          session: path.sessionId
      - text: Show the details of screen {screen} in session {session}.
        slots:
          screen: path.screenId
          session: path.sessionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sessions/{sessionId}/screens/{screenId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a session screen
      effect: write
      questions:
      - How do I rename or annotate one captured screen?
      - Can I reorder a single screen within a session?
      instructions:
      - text: Rename screen {screen} of session {session} to {title}.
        slots:
          screen: path.screenId
          session: path.sessionId
          title: requestBody.title
      - text: Set annotations {annotations} on screen {screen} in session {session}.
        slots:
          annotations: requestBody.annotations
          screen: path.screenId
          session: path.sessionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sessions/{sessionId}/screens/{screenId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a session screen
      effect: destructive
      questions:
      - How do I remove a captured screen from a session?
      - Can I delete one screen by id?
      instructions:
      - text: Delete screen {screen} from session {session}.
        slots:
          screen: path.screenId
          session: path.sessionId
      - text: Remove captured screen {screen} in session {session}.
        slots:
          screen: path.screenId
          session: path.sessionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sessions/{sessionId}/screens/{screenId}/images'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a screen's image
      effect: read
      questions:
      - Can I download the full-size image of a captured screen?
      - Where is the screenshot image for one screen?
      instructions:
      - text: Get the image of screen {screen} in session {session}.
        slots:
          screen: path.screenId
          session: path.sessionId
      - text: Download the full screenshot for screen {screen} of session {session}.
        slots:
          screen: path.screenId
          session: path.sessionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sessions/{sessionId}/screens/{screenId}/images'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a screen's image
      effect: write
      questions:
      - How do I upload the screenshot for a captured screen?
      - Can I replace the image data of a screen?
      instructions:
      - text: Upload image {file} for screen {screen} in session {session}.
        slots:
          file: requestBody.file
          screen: path.screenId
          session: path.sessionId
      - text: Attach screenshot {file} to screen {screen}.
        slots:
          file: requestBody.file
          screen: path.screenId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sessions/{sessionId}/screens/{screenId}/image-url'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a link to a screen's image
      effect: read
      questions:
      - Can I get a URL to the full screenshot instead of the bytes?
      - What link should I use to show a screen image?
      instructions:
      - text: Return a link where screen {screen} of session {session} can be viewed at full size.
        slots:
          screen: path.screenId
          session: path.sessionId
      - text: Give me a link to the full image of screen {screen}.
        slots:
          screen: path.screenId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sessions/{sessionId}/screens/{screenId}/thumbnail'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a screen's thumbnail
      effect: read
      questions:
      - Can I download a small thumbnail of a captured screen?
      - Is there a preview-size image for each screen?
      instructions:
      - text: Get the thumbnail of screen {screen} in session {session}.
        slots:
          screen: path.screenId
          session: path.sessionId
      - text: Download the preview thumbnail for screen {screen}.
        slots:
          screen: path.screenId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sessions/{sessionId}/screens/{screenId}/thumbnail-url'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a link to a screen's thumbnail
      effect: read
      questions:
      - Can I get a URL for a screen's thumbnail rather than the file?
      - What link shows the preview thumbnail of a screen?
      instructions:
      - text: Return a preview link for screen {screen} in session {session}.
        slots:
          screen: path.screenId
          session: path.sessionId
      - text: Give me a link to the thumbnail preview of screen {screen}.
        slots:
          screen: path.screenId
      method: generated
      generated: '2026-10-01'