# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Knock Management API (mAPI) Email layouts API
  version: 1.0.0
extends: openapi/knock-app-email-layouts-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['/v1/email_layouts'].get
  update:
    x-apievangelist-phrasing:
      intent: List email layouts
      effect: read
      questions:
      - Which email layouts are available in this environment?
      - Can I list layouts on a specific branch?
      instructions:
      - text: List email layouts in {environment}.
        slots:
          environment: query.environment
      - text: Show {limit} email layouts on branch {branch} in {environment}.
        slots:
          limit: query.limit
          branch: query.branch
          environment: query.environment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/email_layouts/{email_layout_key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an email layout by key
      effect: read
      questions:
      - How do I view the HTML and text of one email layout?
      - Can I fetch a layout without its uncommitted edits?
      instructions:
      - text: Get email layout {email_layout_key} in {environment}.
        slots:
          email_layout_key: path.email_layout_key
          environment: query.environment
      - text: Show the {email_layout_key} layout.
        slots:
          email_layout_key: path.email_layout_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/email_layouts/{email_layout_key}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update an email layout
      effect: write
      questions:
      - How do I create or edit an email layout in development?
      - Can I commit a layout change right when I save it?
      instructions:
      - text: Upsert email layout {email_layout_key} in {environment} with {email_layout}.
        slots:
          email_layout_key: path.email_layout_key
          environment: query.environment
          email_layout: requestBody.email_layout
      - text: Save layout {email_layout_key} and commit with message {commit_message} in {environment}.
        slots:
          email_layout_key: path.email_layout_key
          commit_message: query.commit_message
          environment: query.environment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/email_layouts/{email_layout_key}/validate'].put
  update:
    x-apievangelist-phrasing:
      intent: Validate an email layout without saving
      effect: read
      questions:
      - Can I check an email layout for errors before saving it?
      - Is there a dry run for layout payloads?
      instructions:
      - text: Validate email layout payload {email_layout} for {email_layout_key} in {environment}.
        slots:
          email_layout: requestBody.email_layout
          email_layout_key: path.email_layout_key
          environment: query.environment
      - text: Check layout {email_layout_key} definition {email_layout} without persisting it in {environment}.
        slots:
          email_layout_key: path.email_layout_key
          email_layout: requestBody.email_layout
          environment: query.environment
      method: generated
      generated: '2026-10-01'