Talon.One · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Management Collections API

17 actions 17 updates phrasing extends openapi/talon-one-collections-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 17 · first 16 shown; the file carries all of them

$.info
$.paths['/v1/collections'].get
$.paths['/v1/collections'].post
$.paths['/v1/collections/{collectionId}'].get
$.paths['/v1/collections/{collectionId}'].put
$.paths['/v1/collections/{collectionId}'].delete
$.paths['/v1/collections/{collectionId}/items'].get
$.paths['/v1/applications/{applicationId}/collections'].get
$.paths['/v1/applications/{applicationId}/campaigns/{campaignId}/collections'].get
$.paths['/v1/applications/{applicationId}/campaigns/{campaignId}/collections'].post
$.paths['/v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}'].get
$.paths['/v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}'].put
$.paths['/v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}'].delete
$.paths['/v1/collections/{collectionId}/import'].post
$.paths['/v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/import'].post
$.paths['/v1/collections/{collectionId}/export'].get

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 Collections API
  version: 1.0.0
extends: openapi/talon-one-collections-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: 16
- target: $.paths['/v1/collections'].get
  update:
    x-apievangelist-phrasing:
      intent: List account-level collections
      effect: read
      questions:
      - What account-wide collections have I set up for use across Applications?
      - Can I search my account-level collections by name?
      instructions:
      - text: List all account-level collections.
      - text: Find account-level collections named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/collections'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an account-level collection
      effect: write
      questions:
      - How do I create a shared list of SKUs that every Application can use in its rules?
      - Can a new account-level collection be enabled only in certain Applications?
      instructions:
      - text: Create an account-level collection named {name}.
        slots:
          name: requestBody.name
      - text: Create account collection {name} enabled in Applications {subscribedApplicationsIds}.
        slots:
          name: requestBody.name
          subscribedApplicationsIds: requestBody.subscribedApplicationsIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/collections/{collectionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account-level collection
      effect: read
      questions:
      - Which Applications is an account-level collection enabled in?
      - Can I look up a shared account collection by its ID?
      instructions:
      - text: Get account-level collection {collectionId}.
        slots:
          collectionId: path.collectionId
      - text: Show the settings of account collection {collectionId}.
        slots:
          collectionId: path.collectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/collections/{collectionId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an account-level collection
      effect: write
      questions:
      - How do I turn an account-wide collection on or off for specific Applications?
      - Can I change the description of a shared account-level collection?
      instructions:
      - text: Enable account collection {collectionId} in Applications {subscribedApplicationsIds}.
        slots:
          collectionId: path.collectionId
          subscribedApplicationsIds: requestBody.subscribedApplicationsIds
      - text: Change the description of account-level collection {collectionId} to {description}.
        slots:
          collectionId: path.collectionId
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/collections/{collectionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account-level collection
      effect: destructive
      questions:
      - How do I remove a shared collection from my whole account?
      - Can I delete an account-level collection I no longer use?
      instructions:
      - text: Delete account-level collection {collectionId}.
        slots:
          collectionId: path.collectionId
      - text: Remove shared account collection {collectionId} permanently.
        slots:
          collectionId: path.collectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/collections/{collectionId}/items'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the items in a collection
      effect: read
      questions:
      - What values are stored in a given collection?
      - Does the same call return items for both account and campaign collections?
      instructions:
      - text: Get the items in collection {collectionId}.
        slots:
          collectionId: path.collectionId
      - text: Show the first {pageSize} values stored in collection {collectionId}.
        slots:
          pageSize: query.pageSize
          collectionId: path.collectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/applications/{applicationId}/collections'].get
  update:
    x-apievangelist-phrasing:
      intent: List campaign collections across an Application
      effect: read
      questions:
      - Which campaign-level collections exist across all campaigns in one Application?
      - Can I find a collection by name without knowing which campaign it belongs to?
      instructions:
      - text: List campaign-level collections from every campaign in Application {applicationId}.
        slots:
          applicationId: path.applicationId
      - text: Search Application {applicationId}'s campaign collections for name {name}.
        slots:
          applicationId: path.applicationId
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/applications/{applicationId}/campaigns/{campaignId}/collections'].get
  update:
    x-apievangelist-phrasing:
      intent: List collections in a campaign
      effect: read
      questions:
      - What collections does one specific campaign have?
      - Can I see how many collections a single campaign holds?
      instructions:
      - text: List the collections in campaign {campaignId} of Application {applicationId}.
        slots:
          campaignId: path.campaignId
          applicationId: path.applicationId
      - text: Find collections named {name} inside campaign {campaignId} in Application {applicationId}.
        slots:
          name: query.name
          campaignId: path.campaignId
          applicationId: path.applicationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/applications/{applicationId}/campaigns/{campaignId}/collections'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a campaign-level collection
      effect: write
      questions:
      - How do I add a collection of eligible SKUs to just one campaign?
      - Can I give a new campaign collection a description?
      instructions:
      - text: Create collection {name} in campaign {campaignId} of Application {applicationId}.
        slots:
          name: requestBody.name
          campaignId: path.campaignId
          applicationId: path.applicationId
      - text: Add a campaign-level collection {name} described as {description} to campaign {campaignId} in Application {applicationId}.
        slots:
          name: requestBody.name
          description: requestBody.description
          campaignId: path.campaignId
          applicationId: path.applicationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a campaign-level collection
      effect: read
      questions:
      - What are the details of a collection that belongs to one campaign?
      - Can I look up a campaign collection by ID?
      instructions:
      - text: Get collection {collectionId} in campaign {campaignId} of Application {applicationId}.
        slots:
          collectionId: path.collectionId
          campaignId: path.campaignId
          applicationId: path.applicationId
      - text: Show campaign-level collection {collectionId} from campaign {campaignId}, Application {applicationId}.
        slots:
          collectionId: path.collectionId
          campaignId: path.campaignId
          applicationId: path.applicationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a campaign collection's description
      effect: write
      questions:
      - Can I edit the description of a collection inside a campaign?
      - What can I change on a campaign-level collection after creating it?
      instructions:
      - text: Set the description of collection {collectionId} in campaign {campaignId}, Application {applicationId}, to {description}.
        slots:
          collectionId: path.collectionId
          campaignId: path.campaignId
          applicationId: path.applicationId
          description: requestBody.description
      - text: Update campaign collection {collectionId} in campaign {campaignId} of Application {applicationId} with description {description}.
        slots:
          collectionId: path.collectionId
          campaignId: path.campaignId
          applicationId: path.applicationId
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a campaign-level collection
      effect: destructive
      questions:
      - How do I delete a collection that belongs to one campaign?
      - Can I remove a campaign collection without touching account-level ones?
      instructions:
      - text: Delete collection {collectionId} from campaign {campaignId} in Application {applicationId}.
        slots:
          collectionId: path.collectionId
          campaignId: path.campaignId
          applicationId: path.applicationId
      - text: Remove campaign-level collection {collectionId} of campaign {campaignId}, Application {applicationId}.
        slots:
          collectionId: path.collectionId
          campaignId: path.campaignId
          applicationId: path.applicationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/collections/{collectionId}/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import items into an account-level collection
      effect: write
      questions:
      - How do I fill a shared account collection from a CSV of values?
      - Does importing a CSV into an account collection replace what's already there?
      instructions:
      - text: Import {upFile} into account-level collection {collectionId}, replacing its contents.
        slots:
          upFile: requestBody.upFile
          collectionId: path.collectionId
      - text: Load the CSV {upFile} into shared account collection {collectionId}.
        slots:
          upFile: requestBody.upFile
          collectionId: path.collectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import items into a campaign-level collection
      effect: write
      questions:
      - How do I upload a CSV of values into a collection that belongs to a campaign?
      - Will uploading new items to a campaign's collection overwrite the old ones?
      instructions:
      - text: Import {upFile} into collection {collectionId} of campaign {campaignId} in Application {applicationId}.
        slots:
          upFile: requestBody.upFile
          collectionId: path.collectionId
          campaignId: path.campaignId
          applicationId: path.applicationId
      - text: Replace the items of campaign collection {collectionId} (campaign {campaignId}, Application {applicationId}) with CSV {upFile}.
        slots:
          collectionId: path.collectionId
          campaignId: path.campaignId
          applicationId: path.applicationId
          upFile: requestBody.upFile
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/collections/{collectionId}/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export an account-level collection's items to CSV
      effect: read
      questions:
      - Can I download the values of a shared account collection as a CSV?
      - How do I back up an account-level collection before re-importing it?
      instructions:
      - text: Export the items of account-level collection {collectionId} to CSV.
        slots:
          collectionId: path.collectionId
      - text: Download shared account collection {collectionId} as a file.
        slots:
          collectionId: path.collectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a campaign-level collection's items to CSV
      effect: read
      questions:
      - Can I download the items of a collection that belongs to one campaign?
      - What's in a campaign's collection, as a CSV file?
      instructions:
      - text: Export collection {collectionId} of campaign {campaignId} in Application {applicationId} to CSV.
        slots:
          collectionId: path.collectionId
          campaignId: path.campaignId
          applicationId: path.applicationId
      - text: Download campaign-level collection {collectionId} items from campaign {campaignId}, Application {applicationId}.
        slots:
          collectionId: path.collectionId
          campaignId: path.campaignId
          applicationId: path.applicationId
      method: generated
      generated: '2026-09-26'