API Evangelist conversational phrasing for Qliksense Task API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Qliksense Task API
  version: 1.0.0
extends: openapi/qliksense-task-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 21
- target: $.paths['/api/scheduling/tasks'].get
  update:
    x-apievangelist-phrasing:
      intent: List scheduled tasks I can access
      effect: read
      questions:
      - Which scheduling tasks can I see in my Qlik Cloud tenant, and when did each last run?
      - Can I filter the scheduling task list with a SCIM expression and sort it?
      instructions:
      - text: List the scheduling tasks I have access to, sorted by {sort}.
        slots:
          sort: query.sort
      - text: Show scheduling tasks that operate on resource {resourceId}.
        slots:
          resourceId: query.resourceId
      - text: Find scheduling tasks matching the filter {filter}, {limit} per page.
        slots:
          filter: query.filter
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/scheduling/tasks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a scheduled workflow task
      effect: write
      questions:
      - How do I create a new scheduled task with a Serverless Workflow definition?
      - Is a newly created scheduling task enabled straight away, or do I have to turn it on?
      instructions:
      - text: Create a scheduling task named {name} using workflow spec version {specVersion}.
        slots:
          name: requestBody.name
          specVersion: requestBody.specVersion
      - text: Set up a new scheduled task {name} on spec {specVersion} with the start schedule {start}.
        slots:
          name: requestBody.name
          specVersion: requestBody.specVersion
          start: requestBody.start
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/scheduling/tasks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a scheduled task's full definition
      effect: read
      questions:
      - What trigger and state definitions does one of my scheduling tasks have?
      - Can I inspect a scheduled task's owner and last run status before I change it?
      instructions:
      - text: Show me the full definition of scheduling task {id}.
        slots:
          id: path.id
      - text: Get the trigger configuration and owner of scheduled task {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/scheduling/tasks/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a scheduled task's whole definition
      effect: write
      questions:
      - What happens to fields I leave out when I replace a scheduling task's full definition?
      - Does replacing someone else's scheduled task transfer ownership to me?
      instructions:
      - text: Replace the entire definition of scheduling task {id} with name {name} and spec version {specVersion}.
        slots:
          id: path.id
          name: requestBody.name
          specVersion: requestBody.specVersion
      - text: Overwrite scheduled task {id} completely, setting enabled to {enabled}, name {name} and spec {specVersion}.
        slots:
          id: path.id
          enabled: requestBody.enabled
          name: requestBody.name
          specVersion: requestBody.specVersion
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/scheduling/tasks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a scheduled task and cancel its runs
      effect: destructive
      questions:
      - Does deleting a scheduling task also cancel its pending runs?
      - Can a tenant admin remove a scheduled task that another user owns?
      instructions:
      - text: Delete scheduling task {id} and cancel anything it has queued.
        slots:
          id: path.id
      - text: Permanently remove scheduled task {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/scheduling/tasks/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a scheduled task
      effect: write
      questions:
      - Can I change just one field of a scheduling task with a JSON Patch instead of resending the whole thing?
      - How do I disable a single scheduled task without touching the rest of its definition?
      instructions:
      - text: Apply a JSON Patch to scheduling task {id} that only changes its enabled flag.
        slots:
          id: path.id
      - text: Partially update scheduled task {id}, leaving every other field as it is.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/scheduling/tasks/{id}/actions/start'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a scheduled task immediately
      effect: write
      questions:
      - Can I trigger a scheduling task right now outside its normal schedule?
      - Where does the source I pass when starting a scheduled task get recorded?
      instructions:
      - text: Start scheduling task {id} now.
        slots:
          id: path.id
      - text: Run scheduled task {id} immediately and record {source} as what triggered it.
        slots:
          id: path.id
          source: query.source
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/scheduling/tasks/{id}/runs'].get
  update:
    x-apievangelist-phrasing:
      intent: List the run history of a scheduled task
      effect: read
      questions:
      - When did one of my scheduling tasks run, and who triggered each run?
      - Can I page through a scheduled task's full run history, newest first?
      instructions:
      - text: List the runs of scheduling task {id}.
        slots:
          id: path.id
      - text: Show {limit} runs per page for scheduled task {id}, sorted by {sort}.
        slots:
          limit: query.limit
          id: path.id
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/scheduling/tasks/{id}/runs/{runId}/log'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the log of a scheduled task run
      effect: read
      questions:
      - Where can I read the execution log for one particular run of a scheduling task?
      - Can I download a scheduled task's run log as a plain text file instead of JSON?
      instructions:
      - text: Get the log for run {runId} of scheduling task {id}.
        slots:
          runId: path.runId
          id: path.id
      - text: Download the log of scheduled task {id} run {runId} in {Accept} format.
        slots:
          id: path.id
          runId: path.runId
          Accept: header.Accept
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/scheduling/tasks/{id}/runs/last'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a scheduled task's most recent run
      effect: read
      questions:
      - Did the last run of my scheduling task succeed or fail?
      - What comes back for the latest run if a scheduled task has never been run?
      instructions:
      - text: Show the most recent run of scheduling task {id}.
        slots:
          id: path.id
      - text: Tell me whether scheduled task {id} succeeded on its last run.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/scheduling/tasks/resources/{id}/runs'].get
  update:
    x-apievangelist-phrasing:
      intent: List scheduled task runs for a resource
      effect: read
      questions:
      - How can I see the run history of every scheduling task attached to one app or resource?
      - Can I list task runs across all scheduled tasks for a single resource?
      instructions:
      - text: List scheduling task runs across all tasks for resource {id}.
        slots:
          id: path.id
      - text: Show the latest {limit} scheduled task runs for resource {id}.
        slots:
          limit: query.limit
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/tasks'].get
  update:
    x-apievangelist-phrasing:
      intent: List tasks via the older v1 tasks API
      effect: read
      questions:
      - How do I list tasks through the older /api/v1/tasks endpoint?
      - Does the legacy v1 task list sort by last update by default?
      instructions:
      - text: Using the legacy v1 tasks API, list my tasks.
      - text: With the older v1 tasks endpoint, list tasks targeting resource {resourceId}.
        slots:
          resourceId: query.resourceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/tasks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a task via the v1 API or migrate a reload task
      effect: write
      questions:
      - Can I migrate an old reload task into the new task system when creating a task?
      - What is required to create a task through the legacy v1 tasks endpoint?
      instructions:
      - text: Create a v1 task named {name} on workflow spec {specVersion}, migrated from reload task {migrateFrom}.
        slots:
          name: requestBody.name
          specVersion: requestBody.specVersion
          migrateFrom: query.migrateFrom
      - text: Through the older v1 tasks API, create task {name} with spec version {specVersion}.
        slots:
          name: requestBody.name
          specVersion: requestBody.specVersion
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/tasks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a task via the older v1 tasks API
      effect: read
      questions:
      - How do I fetch a task's details from the legacy /api/v1/tasks endpoint?
      - Can the older v1 tasks API still return a single task by its id?
      instructions:
      - text: Using the legacy v1 tasks API, get task {id}.
        slots:
          id: path.id
      - text: Fetch details of v1 task {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/tasks/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a task via the older v1 tasks API
      effect: write
      questions:
      - Does updating a task through the legacy v1 endpoint take ownership of it?
      - What must I send to update a task with the older v1 tasks API?
      instructions:
      - text: Through the v1 tasks API, update task {id} with name {name} and spec version {specVersion}.
        slots:
          id: path.id
          name: requestBody.name
          specVersion: requestBody.specVersion
      - text: Use the legacy v1 endpoint to set task {id} enabled to {enabled}, keeping name {name} and spec {specVersion}.
        slots:
          id: path.id
          enabled: requestBody.enabled
          name: requestBody.name
          specVersion: requestBody.specVersion
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/tasks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a task via the older v1 tasks API
      effect: destructive
      questions:
      - How do I delete a task through the legacy /api/v1/tasks endpoint?
      - Can I still remove tasks with the older v1 tasks API?
      instructions:
      - text: Using the legacy v1 tasks API, delete task {id}.
        slots:
          id: path.id
      - text: Remove v1 task {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/tasks/{id}/actions/start'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a task via the older v1 tasks API
      effect: write
      questions:
      - Can I kick off a task through the legacy v1 start action?
      - What trigger origin does the older v1 start endpoint record if I pass none?
      instructions:
      - text: Using the legacy v1 tasks API, start task {id}.
        slots:
          id: path.id
      - text: Start v1 task {id} with trigger origin {source}.
        slots:
          id: path.id
          source: query.source
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/tasks/{id}/runs'].get
  update:
    x-apievangelist-phrasing:
      intent: List task runs via the older v1 tasks API
      effect: read
      questions:
      - How do I list a task's runs through the legacy /api/v1/tasks endpoint?
      - Does the older v1 run list sort by start time by default?
      instructions:
      - text: Using the legacy v1 tasks API, list the runs of task {id}.
        slots:
          id: path.id
      - text: Show {limit} v1 runs of task {id} per page.
        slots:
          limit: query.limit
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/tasks/{id}/runs/{runId}/log'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a task run log via the older v1 tasks API
      effect: read
      questions:
      - Can I read a run log through the legacy v1 tasks endpoint?
      - Which content types can I request for a run log from the older v1 API?
      instructions:
      - text: Using the legacy v1 tasks API, get the log for run {runId} of task {id}.
        slots:
          runId: path.runId
          id: path.id
      - text: Fetch the v1 log of task {id} run {runId} as {Accept}.
        slots:
          id: path.id
          runId: path.runId
          Accept: header.Accept
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/tasks/{id}/runs/last'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a task's last run via the older v1 API
      effect: read
      questions:
      - How do I get a task's latest run through the legacy /api/v1/tasks endpoint?
      - Does the older v1 tasks API expose the last run of a task?
      instructions:
      - text: Using the legacy v1 tasks API, show the last run of task {id}.
        slots:
          id: path.id
      - text: Get the v1 last-run record for task {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/tasks/resources/{id}/runs'].get
  update:
    x-apievangelist-phrasing:
      intent: List a resource's task runs via the older v1 API
      effect: read
      questions:
      - Can the legacy v1 tasks endpoint list runs for a whole resource?
      - How do I list task runs by resource ID with the older /api/v1/tasks API?
      instructions:
      - text: Using the legacy v1 tasks API, list task runs for resource {id}.
        slots:
          id: path.id
      - text: Show v1 task runs for resource {id}, sorted by {sort}.
        slots:
          id: path.id
          sort: query.sort
      method: generated
      generated: '2026-09-26'