Lytics · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for V1 Lytics Catalog API

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

$.info

$.paths['/api/schema/_streams'].get

$.paths['/api/schema/_streams/{stream},{hidden}'].post

$.paths['/api/schema/_streams/{stream},{name},{hidden}'].post

$.paths['/api/schema/{table}'].get

$.paths['/api/schema/{table}/fieldinfo'].get

$.paths['/api/schema/{table}/fieldsuggest/{field}'].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 V1 Lytics Catalog API
  version: 1.0.0
extends: openapi/lytics-catalog-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: 6
- target: $.paths['/api/schema/_streams'].get
  update:
    x-apievangelist-phrasing:
      intent: List data streams and their fields
      effect: read
      questions:
      - Which data streams do I have and what fields does each contain?
      - Can I see field info across all my streams in the schema?
      instructions:
      - text: List my data streams with their fields.
      - text: Show the schema field info for every stream.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/schema/_streams/{stream},{hidden}'].post
  update:
    x-apievangelist-phrasing:
      intent: Hide or unhide a stream in the UI
      effect: write
      questions:
      - Can I hide a temporary stream from the Data Streams screen without deleting its data?
      - Does hiding a stream stop its data flowing into profiles?
      instructions:
      - text: Set stream {stream} hidden to {hidden}.
        slots:
          stream: path.stream
          hidden: path.hidden
      - text: Hide stream {stream} from the web UI by setting hidden {hidden}.
        slots:
          stream: path.stream
          hidden: path.hidden
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/schema/_streams/{stream},{name},{hidden}'].post
  update:
    x-apievangelist-phrasing:
      intent: Hide or unhide a stream field in the UI
      effect: write
      questions:
      - Can I hide a single field of a stream from the web UI?
      - Does hiding a field in a stream delete the data behind it?
      instructions:
      - text: Set field {name} on stream {stream} hidden to {hidden}.
        slots:
          name: path.name
          stream: path.stream
          hidden: path.hidden
      - text: Hide the {name} field of stream {stream} ({hidden}).
        slots:
          name: path.name
          stream: path.stream
          hidden: path.hidden
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/schema/{table}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the field schema for a table
      effect: read
      questions:
      - What fields are defined on the user table schema?
      - Can I list the schema fields for a node type like user?
      instructions:
      - text: Show the schema fields for table {table}.
        slots:
          table: path.table
      - text: List every field defined on the {table} table.
        slots:
          table: path.table
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/schema/{table}/fieldinfo'].get
  update:
    x-apievangelist-phrasing:
      intent: Get possible values for a table's fields
      effect: read
      questions:
      - Which values actually appear in each field of the user table?
      - Can I limit field info to just a few fields?
      instructions:
      - text: Show the values found in fields {fields} of table {table}.
        slots:
          fields: query.fields
          table: path.table
      - text: Get field-level value info for table {table}, up to {limit} values.
        slots:
          table: path.table
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/schema/{table}/fieldsuggest/{field}'].get
  update:
    x-apievangelist-phrasing:
      intent: Suggest values for a field (autocomplete)
      effect: read
      questions:
      - Can I get autocomplete suggestions for a field's values?
      - What values should I suggest as someone types into a field?
      instructions:
      - text: Suggest values for field {field} on table {table}.
        slots:
          field: path.field
          table: path.table
      - text: Give me autocomplete options for {field} in {table}.
        slots:
          field: path.field
          table: path.table
      method: generated
      generated: '2026-10-01'