Lytics · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Lytics Templates API
9 actions
9 updates
phrasing
extends
openapi/lytics-templates-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Lytics's API. It is a proposal applied on top of the contract, not a document Lytics publishes.
What the actions change
x-apievangelist-phrasing
Targets 9
$.info
$.paths['/template'].get
$.paths['/template'].post
$.paths['/template/test'].post
$.paths['/template/{id}'].get
$.paths['/template/{id}'].post
$.paths['/template/{id}'].delete
$.paths['/template/{id}/definition'].get
$.paths['/template/{id}/test'].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 Lytics Templates API
version: 1.0.0
extends: openapi/lytics-templates-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-02'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 8
- target: $.paths['/template'].get
update:
x-apievangelist-phrasing:
intent: List templates
effect: read
questions:
- Which export templates have been set up on my account?
- Can I see every template in one list?
instructions:
- text: List all my templates.
- text: Show the templates on account {account_id}.
slots:
account_id: query.account_id
method: generated
generated: '2026-10-02'
- target: $.paths['/template'].post
update:
x-apievangelist-phrasing:
intent: Create a template
effect: write
questions:
- How do I create a new template of a given type?
- What name and type does a new template need?
instructions:
- text: Create a {type} template named {name}.
slots:
type: query.type
name: query.name
- text: Create template {name} of type {type} described as {description}.
slots:
name: query.name
type: query.type
description: query.description
method: generated
generated: '2026-10-02'
- target: $.paths['/template/test'].post
update:
x-apievangelist-phrasing:
intent: Test an unsaved template definition
effect: read
questions:
- Can I try out a template definition before saving it?
- What would a draft template render for a sample entity?
instructions:
- text: Test template definition {template_definition} against entity {entity}.
slots:
template_definition: requestBody.template_definition
entity: requestBody.entity
- text: Dry-run an unsaved {template_type} template with sample segments {sample_segments}.
slots:
template_type: requestBody.template_type
sample_segments: requestBody.sample_segments
method: generated
generated: '2026-10-02'
- target: $.paths['/template/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get one template
effect: read
questions:
- Can I look up a single template by its id?
- What name and type does a particular template have?
instructions:
- text: Show template {id}.
slots:
id: path.id
- text: Fetch the metadata of template {id}.
slots:
id: path.id
method: generated
generated: '2026-10-02'
- target: $.paths['/template/{id}'].post
update:
x-apievangelist-phrasing:
intent: Update a template's name or type
effect: write
questions:
- Can I rename an existing template?
- Is it possible to change a saved template's type or description?
instructions:
- text: Rename template {id} to {name}, keeping type {type}.
slots:
id: path.id
name: query.name
type: query.type
- text: Update template {id} with name {name}, type {type} and description {description}.
slots:
id: path.id
name: query.name
type: query.type
description: query.description
method: generated
generated: '2026-10-02'
- target: $.paths['/template/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a template
effect: destructive
questions:
- How do I delete a template I no longer use?
- Can a saved template be removed permanently?
instructions:
- text: Delete template {id}.
slots:
id: path.id
- text: Permanently remove template {id} from my account.
slots:
id: path.id
method: generated
generated: '2026-10-02'
- target: $.paths['/template/{id}/definition'].get
update:
x-apievangelist-phrasing:
intent: Get a template's definition body
effect: read
questions:
- What does the actual body of a saved template contain?
- Can I read the definition behind one template?
instructions:
- text: Show the definition of template {id}.
slots:
id: path.id
- text: Print the template body for {id}.
slots:
id: path.id
method: generated
generated: '2026-10-02'
- target: $.paths['/template/{id}/test'].post
update:
x-apievangelist-phrasing:
intent: Test a saved template
effect: read
questions:
- Does a saved template render correctly for a sample entity?
- Can I test an existing template with sample segments?
instructions:
- text: Test saved template {id} against entity {entity}.
slots:
id: path.id
entity: requestBody.entity
- text: Run existing template {id} with sample segments {sample_segments}.
slots:
id: path.id
sample_segments: requestBody.sample_segments
method: generated
generated: '2026-10-02'