Talon.One · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Management Applications API

6 actions 6 updates phrasing extends openapi/talon-one-applications-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/applications'].get

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

$.paths['/v1/applications/{applicationId}/health_report'].get

$.paths['/v1/applications/{applicationId}/cart_item_filters'].get

$.paths['/v1/applications/{applicationId}/cart_item_filters/{cartItemFilterId}/expressions/{expressionId}'].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 Management Applications API
  version: 1.0.0
extends: openapi/talon-one-applications-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/applications'].get
  update:
    x-apievangelist-phrasing:
      intent: List Applications in the account
      effect: read
      questions:
      - What Applications exist in my Talon.One account?
      - Where do I find the IDs of all my Applications?
      instructions:
      - text: List all Applications in my account.
      - text: Show my Applications sorted by {sort}.
        slots:
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/applications/{applicationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an Application
      effect: read
      questions:
      - What currency, timezone and settings does a given Application use?
      - Can I look up one Application's configuration by ID?
      instructions:
      - text: Get Application {applicationId}.
        slots:
          applicationId: path.applicationId
      - text: Show the settings of Application {applicationId}.
        slots:
          applicationId: path.applicationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/applications/{applicationId}/health_report'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an Application's integration health
      effect: read
      questions:
      - Is my integration still talking to this Application, and when was it last used?
      - Can I check an Application's API health without opening the Campaign Manager?
      instructions:
      - text: Check the integration health of Application {applicationId}.
        slots:
          applicationId: path.applicationId
      - text: When was Application {applicationId} last used by an integration? Show its health report.
        slots:
          applicationId: path.applicationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/applications/{applicationId}/cart_item_filters'].get
  update:
    x-apievangelist-phrasing:
      intent: List an Application's cart item filters
      effect: read
      questions:
      - Which cart item filters are defined in an Application?
      - Can I find a cart item filter by name?
      instructions:
      - text: List the cart item filters of Application {applicationId}.
        slots:
          applicationId: path.applicationId
      - text: Find cart item filters named {name} in Application {applicationId}.
        slots:
          name: query.name
          applicationId: path.applicationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/applications/{applicationId}/cart_item_filters/{cartItemFilterId}/expressions/{expressionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a cart item filter expression
      effect: read
      questions:
      - What logic does a specific cart item filter expression contain?
      - Can I read one expression of a cart item filter by its ID?
      instructions:
      - text: Get expression {expressionId} of cart item filter {cartItemFilterId} in Application {applicationId}.
        slots:
          expressionId: path.expressionId
          cartItemFilterId: path.cartItemFilterId
          applicationId: path.applicationId
      - text: Show the filter expression {expressionId} for cart item filter {cartItemFilterId}, Application {applicationId}.
        slots:
          expressionId: path.expressionId
          cartItemFilterId: path.cartItemFilterId
          applicationId: path.applicationId
      method: generated
      generated: '2026-09-26'