Tapfiliate · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Tapfiliate REST Customers API
12 actions
12 updates
phrasing
extends
openapi/tapfiliate-customers-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Tapfiliate's API. It is a proposal applied on top of the contract, not a document Tapfiliate publishes.
What the actions change
x-apievangelist-phrasing
Targets 12
$.info
$.paths['/customers/{id}/'].get
$.paths['/customers/{id}/'].delete
$.paths['/customers/{id}/'].patch
$.paths['/customers/'].get
$.paths['/customers/'].post
$.paths['/customers/{id}/status/'].put
$.paths['/customers/{id}/meta-data/'].get
$.paths['/customers/{id}/meta-data/'].put
$.paths['/customers/{id}/meta-data/{key}/'].get
$.paths['/customers/{id}/meta-data/{key}/'].put
$.paths['/customers/{id}/meta-data/{key}/'].delete
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 Tapfiliate REST Customers API
version: 1.0.0
extends: openapi/tapfiliate-customers-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: 11
- target: $.paths['/customers/{id}/'].get
update:
x-apievangelist-phrasing:
intent: Retrieve a customer
effect: read
questions:
- Can I look up one referred customer by their ID?
- What does Tapfiliate store about a single customer?
instructions:
- text: Get customer {id}.
slots:
id: path.id
- text: Show me the record for customer {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/customers/{id}/'].delete
update:
x-apievangelist-phrasing:
intent: Delete a customer
effect: destructive
questions:
- How do I delete a customer record completely?
- Can I remove a customer that was created by mistake?
instructions:
- text: Delete customer {id}.
slots:
id: path.id
- text: Remove customer record {id} permanently.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/customers/{id}/'].patch
update:
x-apievangelist-phrasing:
intent: Update a customer
effect: write
questions:
- Can I change the external identifier on an existing customer?
- Is it possible to update the metadata of a customer I already have?
instructions:
- text: Change customer {id}'s external ID to {customer_id}.
slots:
id: path.id
customer_id: requestBody.customer_id
- text: Update customer {id} with metadata {meta_data}.
slots:
id: path.id
meta_data: requestBody.meta_data
method: generated
generated: '2026-10-01'
- target: $.paths['/customers/'].get
update:
x-apievangelist-phrasing:
intent: List customers
effect: read
questions:
- Which customers have been referred by my affiliates?
- Can I page through all my customers?
instructions:
- text: List all customers.
- text: Show page {page} of customers with {limit} per page.
slots:
page: query.page
limit: query.limit
method: generated
generated: '2026-10-01'
- target: $.paths['/customers/'].post
update:
x-apievangelist-phrasing:
intent: Create a customer
effect: write
questions:
- How do I register a referred customer, for example on a trial signup?
- What identifier do I need to create a customer?
instructions:
- text: Create a customer with external ID {customer_id}.
slots:
customer_id: requestBody.customer_id
- text: Add customer {customer_id} with metadata {meta_data}.
slots:
customer_id: requestBody.customer_id
meta_data: requestBody.meta_data
method: generated
generated: '2026-10-01'
- target: $.paths['/customers/{id}/status/'].put
update:
x-apievangelist-phrasing:
intent: Cancel or reactivate a customer
effect: write
questions:
- How do I mark a customer as cancelled when they churn?
- Can I uncancel a customer who came back?
instructions:
- text: Set customer {id}'s status to {status}.
slots:
id: path.id
status: requestBody.status
- text: Cancel customer {id} by setting status {status}.
slots:
id: path.id
status: requestBody.status
method: generated
generated: '2026-10-01'
- target: $.paths['/customers/{id}/meta-data/'].get
update:
x-apievangelist-phrasing:
intent: Get all metadata for a customer
effect: read
questions:
- What custom metadata is stored on a customer?
- Can I fetch every metadata key on one customer at once?
instructions:
- text: Get all metadata for customer {id}.
slots:
id: path.id
- text: Show the full metadata set on customer {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/customers/{id}/meta-data/'].put
update:
x-apievangelist-phrasing:
intent: Replace a customer's metadata
effect: write
questions:
- Can I overwrite a customer's whole metadata object in one call?
- What happens to existing customer metadata keys when I replace it all?
instructions:
- text: Replace all metadata on customer {id}.
slots:
id: path.id
- text: Overwrite the entire metadata set for customer {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/customers/{id}/meta-data/{key}/'].get
update:
x-apievangelist-phrasing:
intent: Get one metadata key for a customer
effect: read
questions:
- Can I read one metadata value on a customer by its key?
- What value does a customer have for a specific metadata key?
instructions:
- text: Get metadata key {key} for customer {id}.
slots:
id: path.id
key: path.key
- text: Show customer {id}'s {key} metadata value.
slots:
id: path.id
key: path.key
method: generated
generated: '2026-10-01'
- target: $.paths['/customers/{id}/meta-data/{key}/'].put
update:
x-apievangelist-phrasing:
intent: Set one metadata key on a customer
effect: write
questions:
- Can I set a single metadata key on a customer without touching the others?
- Is there a way to update one customer metadata field?
instructions:
- text: Set metadata key {key} on customer {id}.
slots:
id: path.id
key: path.key
- text: Update only the {key} metadata field for customer {id}.
slots:
id: path.id
key: path.key
method: generated
generated: '2026-10-01'
- target: $.paths['/customers/{id}/meta-data/{key}/'].delete
update:
x-apievangelist-phrasing:
intent: Delete one metadata key from a customer
effect: destructive
questions:
- Can I remove a single metadata key from a customer?
- How do I drop one custom field from a customer's metadata?
instructions:
- text: Delete metadata key {key} from customer {id}.
slots:
id: path.id
key: path.key
- text: Remove the {key} metadata entry on customer {id}.
slots:
id: path.id
key: path.key
method: generated
generated: '2026-10-01'