Treasure Data · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for cdp-api Activation Templates API

6 actions 6 updates phrasing extends openapi/treasure-data-activation-templates-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/entities/activation_templates'].post

$.paths['/entities/activation_templates/{id}'].get

$.paths['/entities/activation_templates/{id}'].delete

$.paths['/entities/activation_templates/{id}'].patch

$.paths['/entities/parent_segments/{parentSegmentId}/activation_templates'].get

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 cdp-api Activation Templates API
  version: 1.0.0
extends: openapi/treasure-data-activation-templates-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: 5
- target: $.paths['/entities/activation_templates'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an activation template
      effect: write
      questions:
      - How do I save a reusable activation setup as a template?
      - What attributes go into a new activation template?
      instructions:
      - text: Create an activation template with attributes {attributes}.
        slots:
          attributes: requestBody.attributes
      - text: Save a new activation template using attributes {attributes} and relationships {relationships}.
        slots:
          attributes: requestBody.attributes
          relationships: requestBody.relationships
      method: generated
      generated: '2026-09-26'
- target: $.paths['/entities/activation_templates/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an activation template
      effect: read
      questions:
      - What settings does a particular activation template hold?
      - Can I look up one activation template by its ID?
      instructions:
      - text: Show activation template {id}.
        slots:
          id: path.id
      - text: Get the configuration of activation template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/entities/activation_templates/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an activation template
      effect: destructive
      questions:
      - How do I remove an activation template nobody uses?
      - Can an activation template be deleted permanently?
      instructions:
      - text: Delete activation template {id}.
        slots:
          id: path.id
      - text: Remove the activation template with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/entities/activation_templates/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an activation template
      effect: write
      questions:
      - Can I change the settings saved in an existing activation template?
      - Is it possible to edit an activation template's relationships?
      instructions:
      - text: Update activation template {id} with attributes {attributes}.
        slots:
          id: path.id
          attributes: requestBody.attributes
      - text: Change the relationships of activation template {id} to {relationships}.
        slots:
          id: path.id
          relationships: requestBody.relationships
      method: generated
      generated: '2026-09-26'
- target: $.paths['/entities/parent_segments/{parentSegmentId}/activation_templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List activation templates for a parent segment
      effect: read
      questions:
      - Which activation templates are available in a parent segment?
      - Can I list only the templates usable by a particular segment?
      instructions:
      - text: List activation templates for parent segment {parentSegmentId}.
        slots:
          parentSegmentId: path.parentSegmentId
      - text: List {kind} activation templates in parent segment {parentSegmentId} usable by segment {availableBySegmentId}.
        slots:
          kind: query.kind
          parentSegmentId: path.parentSegmentId
          availableBySegmentId: query.availableBySegmentId
      method: generated
      generated: '2026-10-01'