API Evangelist conversational phrasing for act.web.api Task Types API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for act.web.api Task Types API
  version: 1.0.0
extends: openapi/act-task-types-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/task-types/{taskTypeId}/regarding-dropdown'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a task type's regarding options
      effect: read
      questions:
      - What regarding options are offered for a given task type?
      - Where do I get the regarding dropdown list for a task type?
      instructions:
      - text: Get the regarding dropdown for task type {taskTypeId}.
        slots:
          taskTypeId: path.taskTypeId
      - text: Show the regarding choices for task type {taskTypeId}.
        slots:
          taskTypeId: path.taskTypeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/task-types'].get
  update:
    x-apievangelist-phrasing:
      intent: List task types
      effect: read
      questions:
      - What task types are available?
      - Can I see both built-in and custom task types?
      instructions:
      - text: List all task types.
      - text: Show every task type.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/task-types'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom task type
      effect: write
      questions:
      - How do I add a custom task type?
      - Can a new task type be created inactive?
      instructions:
      - text: Create a custom task type named {name}.
        slots:
          name: requestBody.name
      - text: Create task type {name} with description {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/task-types/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a task type
      effect: read
      questions:
      - How do I look up one task type by ID?
      - Is a specific task type custom or deletable?
      instructions:
      - text: Show task type {id}.
        slots:
          id: path.id
      - text: Get the details of task type {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/task-types/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a custom task type
      effect: write
      questions:
      - How do I fully update a custom task type?
      - Can I overwrite a custom task type's name and description together?
      instructions:
      - text: Update task type {id} with name {name} and description {description}.
        slots:
          id: path.id
          name: requestBody.name
          description: requestBody.description
      - text: Overwrite custom task type {id} with history types {historyTypes}.
        slots:
          id: path.id
          historyTypes: requestBody.historyTypes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/task-types/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom task type
      effect: destructive
      questions:
      - How do I delete a custom task type?
      - Can I remove a task type I created?
      instructions:
      - text: Delete task type {id}.
        slots:
          id: path.id
      - text: Remove custom task type {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/task-types/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a custom task type
      effect: write
      questions:
      - Can I deactivate a custom task type without changing anything else?
      - Is there a partial update for a single task type?
      instructions:
      - text: Rename task type {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set task type {id} active flag to {isActive}.
        slots:
          id: path.id
          isActive: requestBody.isActive
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/task-types/batch'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update several task types at once
      effect: write
      questions:
      - Can I partially update a batch of task types in one call?
      - What patches multiple existing task types together?
      instructions:
      - text: Update this batch of task types.
      - text: Apply partial updates to several task types at once.
      method: generated
      generated: '2026-10-01'