API Evangelist conversational phrasing for Hightouch Models API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Hightouch Models API
  version: 1.0.0
extends: openapi/hightouch-models-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['/models/{modelId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a model
      effect: read
      questions:
      - How do I see the query and settings of one model by its ID?
      - What primary key does a particular Hightouch model use?
      instructions:
      - text: Get model {modelId}.
        slots:
          modelId: path.modelId
      - text: Show the query behind model {modelId}.
        slots:
          modelId: path.modelId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/models/{modelId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit an existing model's query or settings
      effect: write
      questions:
      - Can I change the SQL query on a model I already created?
      - How do I move an existing model into a different folder?
      instructions:
      - text: Replace the SQL of model {modelId} with {raw}.
        slots:
          modelId: path.modelId
          raw: requestBody.raw
      - text: Rename model {modelId} to {name}.
        slots:
          modelId: path.modelId
          name: requestBody.name
      - text: Move model {modelId} into folder {folderId}.
        slots:
          modelId: path.modelId
          folderId: requestBody.folderId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/models'].get
  update:
    x-apievangelist-phrasing:
      intent: List models in the workspace
      effect: read
      questions:
      - Which models exist in my workspace, including parent and related models?
      - Can I filter models by a tag like team:marketing?
      instructions:
      - text: List all models in my workspace.
      - text: Find models tagged {tags}.
        slots:
          tags: query.tags
      - text: Find the model with slug {slug}.
        slots:
          slug: query.slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/models'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a model on a source
      effect: write
      questions:
      - How do I create a new model from a SQL query on one of my sources?
      - What query types can a new model use, like raw SQL, table, dbt or visual?
      instructions:
      - text: Create model {name} ({slug}) on source {sourceId} as a {queryType} query with primary key {primaryKey}, schema-only {isSchema}.
        slots:
          name: requestBody.name
          slug: requestBody.slug
          sourceId: requestBody.sourceId
          queryType: requestBody.queryType
          primaryKey: requestBody.primaryKey
          isSchema: requestBody.isSchema
      - text: Create raw SQL model {name} ({slug}) on source {sourceId} with query {raw}, key {primaryKey}, type {queryType}, schema {isSchema}.
        slots:
          name: requestBody.name
          slug: requestBody.slug
          sourceId: requestBody.sourceId
          raw: requestBody.raw
          primaryKey: requestBody.primaryKey
          queryType: requestBody.queryType
          isSchema: requestBody.isSchema
      method: generated
      generated: '2026-10-01'