Talon.One · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Management Campaign templates API

3 actions 3 updates phrasing extends openapi/talon-one-campaign-templates-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Talon.One's API. It is a proposal applied on top of the contract, not a document Talon.One publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/v1/campaign_templates'].get

$.paths['/v1/applications/{applicationId}/create_campaign_from_template'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Management Campaign templates API
  version: 1.0.0
extends: openapi/talon-one-campaign-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: 2
- target: $.paths['/v1/campaign_templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List campaign templates
      effect: read
      questions:
      - What campaign templates are available to start a new promotion from?
      - Can I list only the templates that are available, or filter by tag?
      instructions:
      - text: List all campaign templates.
      - text: Show {state} campaign templates tagged {tags}.
        slots:
          state: query.state
          tags: query.tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/applications/{applicationId}/create_campaign_from_template'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a campaign from a template
      effect: write
      questions:
      - How do I launch a new campaign based on one of my templates?
      - Can I override template parameters and limits when creating a campaign from it?
      instructions:
      - text: Create campaign {name} in Application {applicationId} from template {templateId}.
        slots:
          name: requestBody.name
          applicationId: path.applicationId
          templateId: requestBody.templateId
      - text: Use template {templateId} to create campaign {name} in Application {applicationId} with parameter values {templateParamValues}.
        slots:
          templateId: requestBody.templateId
          name: requestBody.name
          applicationId: path.applicationId
          templateParamValues: requestBody.templateParamValues
      method: generated
      generated: '2026-09-26'