API Evangelist conversational phrasing for act.web.api History 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 History Types API
  version: 1.0.0
extends: openapi/act-historytypes-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: 5
- target: $.paths['/api/history-types/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a history type
      effect: read
      questions:
      - How do I look up one history type by its id?
      - What does a single history type definition contain?
      instructions:
      - text: Fetch history type {id}.
        slots:
          id: path.id
      - text: Show the details of history type {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/historytypes/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a history type by name (deprecated)
      effect: read
      questions:
      - Can I still look up a history type by name on the old historytypes path?
      - What replaced the deprecated history-type-by-name route?
      instructions:
      - text: Use the deprecated historytypes route to get the history type named {name}.
        slots:
          name: path.name
      - text: Look up history type {name} by name through the legacy endpoint.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/history-types'].get
  update:
    x-apievangelist-phrasing:
      intent: List history types
      effect: read
      questions:
      - What kinds of history entries can be recorded?
      - Which history types are defined in the database?
      instructions:
      - text: List all history types.
      - text: Show every history type I can log.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/historytypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List history types (deprecated route)
      effect: read
      questions:
      - Does the old /api/historytypes listing still work?
      - Is there a legacy endpoint that lists history types?
      instructions:
      - text: List history types through the deprecated historytypes endpoint.
      - text: Call the legacy route to get all history types.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/task-types/{id}/history-types'].get
  update:
    x-apievangelist-phrasing:
      intent: List history types for an activity type
      effect: read
      questions:
      - Which history types go with a given activity type, like a call or meeting?
      - What result options can I record when clearing a task of a certain type?
      instructions:
      - text: List the history types for task type {id}.
        slots:
          id: path.id
      - text: Show which history results apply to activity type {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'