Lucidya · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OmniChannel Default API

4 actions 4 updates phrasing extends openapi/lucidya-ltd-default-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/monitors_list'].get

$.paths['/omnichannel/base/categories'].get

$.paths['/omnichannel/base/widgets'].get

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 OmniChannel Default API
  version: 1.0.0
extends: openapi/lucidya-ltd-default-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: 3
- target: $.paths['/monitors_list'].get
  update:
    x-apievangelist-phrasing:
      intent: List connected OmniChannel channels
      effect: read
      questions:
      - Which channels are connected to my OmniChannel product?
      - How do I page through my omnichannel channel list?
      instructions:
      - text: List my connected omnichannel channels, page {page_id}.
        slots:
          page_id: query.page_id
      - text: Get channels for product {product_name} on page {page_id}.
        slots:
          product_name: query.product_name
          page_id: query.page_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/omnichannel/base/categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List OmniChannel categories and their data sources
      effect: read
      questions:
      - What categories like social media, reviews and calls does OmniChannel group sources into?
      - Which data sources belong to each OmniChannel category?
      instructions:
      - text: List all OmniChannel categories with their data sources.
      - text: Show the page and section names for every OmniChannel category using API key {api_key}.
        slots:
          api_key: header.luc-authorization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/omnichannel/base/widgets'].get
  update:
    x-apievangelist-phrasing:
      intent: List widget names for a channel and category
      effect: read
      questions:
      - What widget names can I request for the TWITTER_PUBLIC channel?
      - Where do I look up valid widget names before creating a widget data job?
      instructions:
      - text: List widget names for page {page_name} in section {section_name}.
        slots:
          page_name: query.page_name
          section_name: query.section_name
      - text: Show available widgets for channel {page_name} under {section_name}.
        slots:
          page_name: query.page_name
          section_name: query.section_name
      method: generated
      generated: '2026-10-01'