Lytics · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for V1 Lytics Account Settings API

5 actions 5 updates phrasing extends openapi/lytics-account-settings-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/account/setting/{setting}'].get
$.paths['/api/account/setting/{setting}'].put
$.paths['/api/account/setting/{setting}'].delete
$.paths['/api/account/setting'].get

OpenAPI Overlay

Raw ↑
# 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 Account Settings API
  version: 1.0.0
extends: openapi/lytics-account-settings-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/account/setting/{setting}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the value of one account setting
      effect: read
      questions:
      - What is the current value of a specific account setting?
      - Can I read one account setting by its slug?
      instructions:
      - text: Show me the value of account setting {setting}.
        slots:
          setting: path.setting
      - text: Get the {setting} setting for my account.
        slots:
          setting: path.setting
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/account/setting/{setting}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an account setting
      effect: write
      questions:
      - Can I change how many days a logon session lasts for my account?
      - How do I set a new value on an account setting?
      instructions:
      - text: Change account setting {setting} to a new value.
        slots:
          setting: path.setting
      - text: Update the {setting} setting on my account.
        slots:
          setting: path.setting
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/account/setting/{setting}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Reset a custom account setting
      effect: destructive
      questions:
      - Can I remove a custom value from an account setting and fall back to the default?
      - What happens to a setting's default when I delete its custom value?
      instructions:
      - text: Delete the custom value of account setting {setting}.
        slots:
          setting: path.setting
      - text: Reset {setting} back to its default by removing my override.
        slots:
          setting: path.setting
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/account/setting'].get
  update:
    x-apievangelist-phrasing:
      intent: List all account settings
      effect: read
      questions:
      - Which account settings exist and what are they set to?
      - Can I see every configurable setting for my account in one call?
      instructions:
      - text: List all my account settings.
      - text: Show every account setting and its current value.
      method: generated
      generated: '2026-10-01'