Talon.One · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Management Additional costs API

5 actions 5 updates phrasing extends openapi/talon-one-additional-costs-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 5

$.info
$.paths['/v1/additional_costs'].get
$.paths['/v1/additional_costs'].post
$.paths['/v1/additional_costs/{additionalCostId}'].get
$.paths['/v1/additional_costs/{additionalCostId}'].put

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 Additional costs API
  version: 1.0.0
extends: openapi/talon-one-additional-costs-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: 4
- target: $.paths['/v1/additional_costs'].get
  update:
    x-apievangelist-phrasing:
      intent: List additional costs
      effect: read
      questions:
      - What additional costs like shipping or gift wrap are defined in my account?
      - Which extra charges can my campaigns discount?
      instructions:
      - text: List all additional costs in my account.
      - text: Show my defined additional costs sorted by {sort}.
        slots:
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/additional_costs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an additional cost
      effect: write
      questions:
      - How do I define a shipping fee so campaigns can discount it?
      - Can I make a new additional cost available only to certain Applications?
      instructions:
      - text: Create additional cost {name} titled {title} with description {description}.
        slots:
          name: requestBody.name
          title: requestBody.title
          description: requestBody.description
      - text: Create an additional cost {name} ({title}, {description}) for Applications {subscribedApplicationsIds}.
        slots:
          name: requestBody.name
          title: requestBody.title
          description: requestBody.description
          subscribedApplicationsIds: requestBody.subscribedApplicationsIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/additional_costs/{additionalCostId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an additional cost
      effect: read
      questions:
      - What are the details of one additional cost definition?
      - Can I look up an additional cost by its ID?
      instructions:
      - text: Get additional cost {additionalCostId}.
        slots:
          additionalCostId: path.additionalCostId
      - text: Show the definition of additional cost {additionalCostId}.
        slots:
          additionalCostId: path.additionalCostId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/additional_costs/{additionalCostId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an additional cost
      effect: write
      questions:
      - Can I change an additional cost's API name after creating it?
      - How do I update the title or Applications of an existing additional cost?
      instructions:
      - text: Rename the title of additional cost {additionalCostId} to {title}.
        slots:
          additionalCostId: path.additionalCostId
          title: requestBody.title
      - text: Enable additional cost {additionalCostId} in Applications {subscribedApplicationsIds}.
        slots:
          additionalCostId: path.additionalCostId
          subscribedApplicationsIds: requestBody.subscribedApplicationsIds
      method: generated
      generated: '2026-09-26'