Hightouch · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hightouch Sources API

5 actions 5 updates phrasing extends openapi/hightouch-sources-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Hightouch's API. It is a proposal applied on top of the contract, not a document Hightouch publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/sources/{sourceId}'].get
$.paths['/sources/{sourceId}'].patch
$.paths['/sources'].get
$.paths['/sources'].post

OpenAPI Overlay

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