# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for ThousandEyes Templates API
  version: 1.0.0
extends: openapi/thousandeyes-templates-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 8
- target: $.paths['/templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List templates
      effect: read
      questions:
      - What templates do I have available in ThousandEyes?
      - Can I filter templates by certification level or module?
      instructions:
      - text: List all my templates.
      - text: Find templates named {name}.
        slots:
          name: query.name
      - text: Show templates with certification level {certificationLevel}.
        slots:
          certificationLevel: query.certificationLevel
      method: generated
      generated: '2026-09-26'
- target: $.paths['/templates'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a template
      effect: write
      questions:
      - Can I package tests, alert rules and dashboards into a reusable template?
      - Can a new template include user inputs that are filled in at deploy time?
      instructions:
      - text: Create a template named {name}.
        slots:
          name: requestBody.name
      - text: Create template {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/templates/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a template
      effect: read
      questions:
      - What is defined inside one particular template?
      - Which tests and dashboards are inside a specific template?
      instructions:
      - text: Show template {id}.
        slots:
          id: path.id
      - text: Get the full definition of template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/templates/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a template's definition
      effect: write
      questions:
      - Does updating a template overwrite the whole object?
      - Is there a way to change the tests bundled in an existing template?
      instructions:
      - text: Update template {id} and rename it to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Overwrite template {id} with a new description {description}.
        slots:
          id: path.id
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/templates/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a template
      effect: destructive
      questions:
      - How do I remove a template I no longer use?
      - Can I delete a template by its ID?
      instructions:
      - text: Delete template {id}.
        slots:
          id: path.id
      - text: Remove template {id} from account group {aid}.
        slots:
          id: path.id
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/templates/{id}/deploy'].post
  update:
    x-apievangelist-phrasing:
      intent: Deploy a template
      effect: write
      questions:
      - What happens when I deploy a template?
      - How do I supply user input values when rolling out a template?
      instructions:
      - text: Deploy template {id}.
        slots:
          id: path.id
      - text: Deploy template {id} with input values {userInputValues}.
        slots:
          id: path.id
          userInputValues: requestBody.userInputValues
      - text: Deploy template {id} as {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/templates/{id}/sharing-settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a template's sharing settings
      effect: read
      questions:
      - Who can see a template I built?
      - Where do I check the sharing scope of a template?
      instructions:
      - text: Show the sharing settings for template {id}.
        slots:
          id: path.id
      - text: Get who template {id} is shared with.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/templates/{id}/sharing-settings'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a template's sharing scope
      effect: write
      questions:
      - Can I share a template with the rest of my organization?
      - How do I restrict a template's sharing scope?
      instructions:
      - text: Set the sharing scope of template {id} to {scope}.
        slots:
          id: path.id
          scope: requestBody.scope
      - text: Change template {id} sharing to {scope}.
        slots:
          id: path.id
          scope: requestBody.scope
      method: generated
      generated: '2026-09-26'