Lytics · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for V1 Lytics Auth API

6 actions 6 updates phrasing extends openapi/lytics-auth-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/auth/{id}'].get

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

$.paths['/api/auth/{id}'].post

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

$.paths['/api/auth/createtoken'].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 Auth API
  version: 1.0.0
extends: openapi/lytics-auth-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/auth/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an integration auth's public details
      effect: read
      questions:
      - Can I look up a stored integration credential without exposing its secrets?
      - Which parts of an auth record are visible when I fetch it?
      instructions:
      - text: Show me the public details of auth {id}.
        slots:
          id: path.id
      - text: Fetch integration auth {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an integration auth
      effect: write
      questions:
      - Can I edit an existing integration auth record?
      - Is it possible to modify a saved credential for an integration?
      instructions:
      - text: Update integration auth {id}.
        slots:
          id: path.id
      - text: Edit the saved auth {id} with new details.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an integration auth
      effect: write
      questions:
      - Can I create an integration auth through the API instead of the Integrations admin page?
      - What config does a new auth need for a provider?
      instructions:
      - text: Create auth {id} for provider {provider_id}.
        slots:
          id: path.id
          provider_id: requestBody.provider_id
      - text: Add a new integration auth {id} with config {config}.
        slots:
          id: path.id
          config: requestBody.config
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an integration auth
      effect: destructive
      questions:
      - What happens to running imports and exports when I delete an auth?
      - Can I remove a stored integration credential?
      instructions:
      - text: Delete integration auth {id}.
        slots:
          id: path.id
      - text: Remove auth {id} and stop any work using it.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/createtoken'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an API token
      effect: write
      questions:
      - How do I generate a new Lytics API token?
      - Can I give an API token specific scopes and an expiry?
      instructions:
      - text: Create an API token named {name} with scopes {scopes}.
        slots:
          name: requestBody.name
          scopes: requestBody.scopes
      - text: Generate a new API token that expires {expires}.
        slots:
          expires: requestBody.expires
      method: generated
      generated: '2026-10-01'