Lytics · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for V1 Lytics Stream API

6 actions 6 updates phrasing extends openapi/lytics-stream-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 6

$.info

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

$.paths['/api/stream/{id}'].put

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

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

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

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 Stream API
  version: 1.0.0
extends: openapi/lytics-stream-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['/api/stream/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a stream's settings
      effect: read
      questions:
      - Can I look up a stream by its id or slug?
      - What channel and label does a particular stream have?
      instructions:
      - text: Show stream {id}.
        slots:
          id: path.id
      - text: Fetch the settings of stream {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/stream/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a stream's settings
      effect: write
      questions:
      - Can I change a stream's label, description or channel?
      - Which stream attributes am I allowed to update?
      instructions:
      - text: Update stream {id}.
        slots:
          id: path.id
      - text: Change the label and description of stream {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/stream/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a stream
      effect: destructive
      questions:
      - Can I delete a stream I no longer collect data on?
      - Is it possible to remove a stream by id?
      instructions:
      - text: Delete stream {id}.
        slots:
          id: path.id
      - text: Remove data stream {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/stream'].get
  update:
    x-apievangelist-phrasing:
      intent: List stream records for my account
      effect: read
      questions:
      - Which stream records are configured on my account?
      - Can I list every stream model with its channel and labels?
      instructions:
      - text: List the stream records on my account.
      - text: Show all stream models with their channels.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/stream'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a stream
      effect: write
      questions:
      - Can I register a new data stream for a channel like email or SMS?
      - What fields does a new stream need, like slug and channel?
      instructions:
      - text: Create a new stream with a slug and channel.
      - text: Register a new web data stream.
      method: generated
      generated: '2026-10-01'