# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for qTest Pulse Action API
  version: 1.0.0
extends: openapi/tricentis-action-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['/actions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's Pulse actions
      effect: read
      questions:
      - Which automation actions are defined in my Pulse project?
      - Can I page through Pulse actions with an offset?
      instructions:
      - text: List the actions in project {project}.
        slots:
          project: query.projectId
      - text: Show the first {first} actions of project {project}.
        slots:
          first: query.first
          project: query.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/actions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Pulse action
      effect: write
      questions:
      - How do I add a new scripted action to a Pulse project?
      - Can I supply the code an action runs when I create it?
      instructions:
      - text: Create an action named {name} in project {project}.
        slots:
          name: requestBody.name
          project: requestBody.projectId
      - text: Add action {name} to project {project} that runs {code}.
        slots:
          name: requestBody.name
          project: requestBody.projectId
          code: requestBody.code
      method: generated
      generated: '2026-10-01'
- target: $.paths['/actions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Pulse action
      effect: read
      questions:
      - What code and description does a given Pulse action have?
      - Can I look up a single action by its id?
      instructions:
      - text: Get action {id}.
        slots:
          id: path.id
      - text: Show me the code of Pulse action {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/actions/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a Pulse action
      effect: write
      questions:
      - Can I fully replace an existing action's name and code?
      - What fields must I resend to overwrite a Pulse action with PUT?
      instructions:
      - text: Replace action {id} with name {name} in project {project}.
        slots:
          id: path.id
          name: requestBody.name
          project: requestBody.projectId
      - text: Overwrite action {id} so its code becomes {code}.
        slots:
          id: path.id
          code: requestBody.code
      method: generated
      generated: '2026-10-01'
- target: $.paths['/actions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Pulse action
      effect: destructive
      questions:
      - How do I remove an action I no longer need from Pulse?
      - Can I delete one automation action by id?
      instructions:
      - text: Delete action {id}.
        slots:
          id: path.id
      - text: Remove Pulse action {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/actions/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch a Pulse action
      effect: write
      questions:
      - Can I rename a Pulse action with a PATCH request?
      - Is there a partial update for an action's description?
      instructions:
      - text: Patch action {id} to rename it {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Partially update the description of action {id} to {description}.
        slots:
          id: path.id
          description: requestBody.description
      method: generated
      generated: '2026-10-01'