# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Hightouch Destinations API
  version: 1.0.0
extends: openapi/hightouch-destinations-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: 4
- target: $.paths['/destinations/{destinationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a destination
      effect: read
      questions:
      - How do I see the details of one destination by its ID?
      - What configuration does a particular Hightouch destination have?
      instructions:
      - text: Get destination {destinationId}.
        slots:
          destinationId: path.destinationId
      - text: Show the configuration of destination {destinationId}.
        slots:
          destinationId: path.destinationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/destinations/{destinationId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a destination's name or configuration
      effect: write
      questions:
      - Can I rename a destination I've already connected?
      - How do I update the credentials or settings on an existing destination?
      instructions:
      - text: Rename destination {destinationId} to {name}.
        slots:
          destinationId: path.destinationId
          name: requestBody.name
      - text: Update the configuration of destination {destinationId} to {configuration}.
        slots:
          destinationId: path.destinationId
          configuration: requestBody.configuration
      method: generated
      generated: '2026-10-01'
- target: $.paths['/destinations'].get
  update:
    x-apievangelist-phrasing:
      intent: List destinations in the workspace
      effect: read
      questions:
      - Which destinations are connected in my workspace?
      - Can I filter my destinations by name or slug?
      instructions:
      - text: List all destinations in my workspace.
      - text: Find destinations named {name}.
        slots:
          name: query.name
      - text: Find the destination with slug {slug}.
        slots:
          slug: query.slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/destinations'].post
  update:
    x-apievangelist-phrasing:
      intent: Connect a new destination
      effect: write
      questions:
      - How do I add a new destination like Salesforce or HubSpot?
      - What do I need to provide to create a destination through the API?
      instructions:
      - text: Create a {type} destination named {name} with slug {slug} and configuration {configuration}.
        slots:
          type: requestBody.type
          name: requestBody.name
          slug: requestBody.slug
          configuration: requestBody.configuration
      - text: Connect a new destination {name} ({slug}) of type {type} using {configuration}.
        slots:
          name: requestBody.name
          slug: requestBody.slug
          type: requestBody.type
          configuration: requestBody.configuration
      method: generated
      generated: '2026-10-01'