Lytics · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for V1 Lytics Subscription API

5 actions 5 updates phrasing extends openapi/lytics-subscription-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/api/subscription'].get

$.paths['/api/subscription'].post

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

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

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 V1 Lytics Subscription API
  version: 1.0.0
extends: openapi/lytics-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: 4
- target: $.paths['/api/subscription'].get
  update:
    x-apievangelist-phrasing:
      intent: List subscriptions
      effect: read
      questions:
      - Which webhook subscriptions do I have?
      - Can I find subscriptions that watch a specific segment?
      instructions:
      - text: List my subscriptions.
      - text: Show subscriptions watching segment {segment_id}.
        slots:
          segment_id: query.segment_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/subscription'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a subscription
      effect: write
      questions:
      - Can I get a webhook when users enter or leave a segment?
      - Can a new subscription backfill users already in the segment?
      instructions:
      - text: Subscribe webhook {webhook_url} to segments {segment_ids}.
        slots:
          webhook_url: requestBody.webhook_url
          segment_ids: requestBody.segment_ids
      - text: Create subscription {name} on channel {channel} with backfill {withbackfill}.
        slots:
          name: requestBody.name
          channel: requestBody.channel
          withbackfill: requestBody.withbackfill
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/subscription/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subscription
      effect: read
      questions:
      - Can I look at one subscription webhook's settings?
      - Which segments does a given subscription watch?
      instructions:
      - text: Show subscription {id}.
        slots:
          id: path.id
      - text: Fetch the webhook subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/subscription/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a subscription
      effect: destructive
      questions:
      - Can I stop a webhook subscription?
      - Is it possible to delete a subscription by id?
      instructions:
      - text: Delete subscription {id}.
        slots:
          id: path.id
      - text: Stop and remove subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'