Khoros · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Khoros Ai Subscription API

6 actions 6 updates phrasing extends openapi/khoros-ai-subscription-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Khoros's API. It is a proposal applied on top of the contract, not a document Khoros publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/subscription'].get

$.paths['/subscription'].post

$.paths['/subscription/{id}'].get

$.paths['/subscription/{id}'].delete

$.paths['/subscription/{id}/{status}'].put

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 Khoros Ai Subscription API
  version: 1.0.0
extends: openapi/khoros-ai-subscription-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: 5
- target: $.paths['/subscription'].get
  update:
    x-apievangelist-phrasing:
      intent: List event subscriptions
      effect: read
      questions:
      - Which event subscriptions are registered for my company?
      - How do I see all the Khoros Marketing event notifications I'm subscribed to?
      instructions:
      - text: List my event subscriptions.
      - text: Show page {page} of subscriptions with {size} per page.
        slots:
          page: query.pageNumber
          size: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscription'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe to an event
      effect: write
      questions:
      - How do I get notified when a specific marketing event happens?
      - Can a subscription call my own URL with a bearer token when events fire?
      - Is it possible to filter subscribed events with a regex query?
      instructions:
      - text: Subscribe to event {event} and notify {url}.
        slots:
          event: requestBody.eventName
          url: requestBody.notificationUri
      - text: Create a subscription to {event} version {version} filtered by {query}.
        slots:
          event: requestBody.eventName
          version: requestBody.version
          query: requestBody.query
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscription/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an event subscription
      effect: read
      questions:
      - How do I check the settings and status of one subscription?
      - What event and callback URL is a subscription using?
      instructions:
      - text: Get subscription {id}.
        slots:
          id: path.id
      - text: Show the details of event subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscription/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an event subscription
      effect: destructive
      questions:
      - How do I stop and remove an event subscription for good?
      - Can I delete a subscription I no longer need?
      instructions:
      - text: Delete subscription {id}.
        slots:
          id: path.id
      - text: Remove event subscription {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscription/{id}/{status}'].put
  update:
    x-apievangelist-phrasing:
      intent: Pause, disable or reactivate a subscription
      effect: write
      questions:
      - Can I pause an event subscription instead of deleting it?
      - What statuses can a subscription be switched to?
      instructions:
      - text: Set subscription {id} to {status}.
        slots:
          id: path.id
          status: path.status
      - text: Change the status of event subscription {id} to {status}.
        slots:
          id: path.id
          status: path.status
      method: generated
      generated: '2026-10-01'