Talon.One · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Management Attributes API

6 actions 6 updates phrasing extends openapi/talon-one-attributes-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 6

$.info
$.paths['/v1/attributes'].get
$.paths['/v1/attributes'].post
$.paths['/v1/attributes/{attributeId}'].get
$.paths['/v1/attributes/{attributeId}'].put
$.paths['/v1/attributes/{attributeId}/allowed_list/import'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Management Attributes API
  version: 1.0.0
extends: openapi/talon-one-attributes-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: 5
- target: $.paths['/v1/attributes'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom attributes
      effect: read
      questions:
      - What custom attributes have been defined for customers, sessions and campaigns in my account?
      - Can I list only the attributes of a given entity or data type?
      instructions:
      - text: List all custom attributes in my account.
      - text: Show custom attributes for entity {entity} of type {type}.
        slots:
          entity: query.entity
          type: query.type
      - text: Search custom attributes for {search}.
        slots:
          search: query.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/attributes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom attribute
      effect: write
      questions:
      - How do I add a new field like 'membership level' to customer profiles?
      - Can a custom attribute be restricted to a picklist of suggested values?
      instructions:
      - text: Create a {type} custom attribute {name} titled {title} on entity {entity}.
        slots:
          type: requestBody.type
          name: requestBody.name
          title: requestBody.title
          entity: requestBody.entity
      - text: Add attribute {name} ({title}) to {entity} with description {description}.
        slots:
          name: requestBody.name
          title: requestBody.title
          entity: requestBody.entity
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/attributes/{attributeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom attribute
      effect: read
      questions:
      - What type and entity does a specific custom attribute belong to?
      - Can I look up a custom attribute definition by ID?
      instructions:
      - text: Get custom attribute {attributeId}.
        slots:
          attributeId: path.attributeId
      - text: Show the definition of attribute {attributeId}.
        slots:
          attributeId: path.attributeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/attributes/{attributeId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom attribute's description
      effect: write
      questions:
      - Can I change the type or name of a custom attribute after it's created?
      - How do I edit the description of an existing custom attribute?
      instructions:
      - text: Update the description of attribute {attributeId} to {description}.
        slots:
          attributeId: path.attributeId
          description: requestBody.description
      - text: Change custom attribute {attributeId}'s description to {description}.
        slots:
          attributeId: path.attributeId
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/attributes/{attributeId}/allowed_list/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import picklist values for an attribute
      effect: write
      questions:
      - How do I upload the list of allowed values for a picklist attribute?
      - Does importing allowed values replace the attribute's previous list?
      instructions:
      - text: Import allowed values from {upFile} for attribute {attributeId}.
        slots:
          upFile: requestBody.upFile
          attributeId: path.attributeId
      - text: Replace the picklist of attribute {attributeId} with CSV {upFile}.
        slots:
          attributeId: path.attributeId
          upFile: requestBody.upFile
      method: generated
      generated: '2026-09-26'