# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Lytics Profiles API
  version: 1.0.0
extends: openapi/lytics-profiles-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/attributes/{table}/{key}/{value}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's profile attributes
      effect: read
      questions:
      - What custom attributes are stored on a particular user's profile?
      - Can I read just the attribute set for one user, keyed by email?
      instructions:
      - text: Show the profile attributes in {table} for the user whose {key} is {value}.
        slots:
          table: path.table
          key: path.key
          value: path.value
      - text: Read the attributes of {table} user {key} = {value}.
        slots:
          table: path.table
          key: path.key
          value: path.value
      method: generated
      generated: '2026-10-02'
- target: $.paths['/attributes/{table}/{key}/{value}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace all of a user's profile attributes
      effect: write
      questions:
      - Can I overwrite every attribute on a user's profile at once?
      - Which call replaces a user's whole attribute set rather than a few fields?
      instructions:
      - text: Replace all profile attributes in {table} for the user whose {key} is {value}.
        slots:
          table: path.table
          key: path.key
          value: path.value
      - text: Overwrite the full attribute set of {table} user {key} = {value}.
        slots:
          table: path.table
          key: path.key
          value: path.value
      method: generated
      generated: '2026-10-02'
- target: $.paths['/attributes/{table}/{key}/{value}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user's profile attributes
      effect: destructive
      questions:
      - Can I clear the stored attributes on a user without deleting the profile?
      - Is there a way to wipe custom attributes from one profile?
      instructions:
      - text: Delete the profile attributes in {table} for the user whose {key} is {value}.
        slots:
          table: path.table
          key: path.key
          value: path.value
      - text: Clear attributes only, keeping the profile, for {table} user {key} = {value}.
        slots:
          table: path.table
          key: path.key
          value: path.value
      method: generated
      generated: '2026-10-02'
- target: $.paths['/attributes/{table}/{key}/{value}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update some of a user's profile attributes
      effect: write
      questions:
      - Can I change a couple of attributes on a profile and leave the rest alone?
      - How do I partially update a user's attributes?
      instructions:
      - text: Patch a few profile attributes in {table} for the user whose {key} is {value}.
        slots:
          table: path.table
          key: path.key
          value: path.value
      - text: Partially update attributes of {table} user {key} = {value}, leaving others unchanged.
        slots:
          table: path.table
          key: path.key
          value: path.value
      method: generated
      generated: '2026-10-02'
- target: $.paths['/identity/deletestatus/{request_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a GDPR profile deletion request
      effect: read
      questions:
      - Has my GDPR deletion request for a user finished yet?
      - Where do I track the progress of a profile deletion?
      instructions:
      - text: Check the status of profile deletion request {request_id}.
        slots:
          request_id: path.request_id
      - text: Tell me whether GDPR deletion {request_id} is complete.
        slots:
          request_id: path.request_id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/identity/lookup'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up a user profile with a POST body
      effect: read
      questions:
      - Can I look up a profile by sending the identity in a POST body instead of the URL?
      - Is it possible to hide some fields when looking up a profile by POST?
      instructions:
      - text: Look up a user profile by POST, leaving out fields {field_blocklist}.
        slots:
          field_blocklist: query.field_blocklist
      - text: Run a POST identity lookup for a user profile on account {account_id}.
        slots:
          account_id: query.account_id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/identity/queue/bulk/{table}/{field}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Queue bulk GDPR deletion of user profiles
      effect: destructive
      questions:
      - Can I submit many GDPR deletion requests in a single batch?
      - What is the bulk way to erase lots of user profiles?
      instructions:
      - text: Queue bulk deletion of profiles in {table} matched by field {field}.
        slots:
          table: path.table
          field: path.field
      - text: Erase many {table} profiles at once, identified by {field}.
        slots:
          table: path.table
          field: path.field
      method: generated
      generated: '2026-10-02'
- target: $.paths['/identity/{table}/{key}/{value}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user profile by identity
      effect: read
      questions:
      - What does the full profile of a customer with a given email look like?
      - Can I fetch one unified user profile by an identity key in the URL?
      instructions:
      - text: Get the {table} profile of the user whose {key} is {value}.
        slots:
          table: path.table
          key: path.key
          value: path.value
      - text: Fetch user profile {table} {key} = {value} without fields {field_blocklist}.
        slots:
          table: path.table
          key: path.key
          value: path.value
          field_blocklist: query.field_blocklist
      method: generated
      generated: '2026-10-02'
- target: $.paths['/identity/{table}/{key}/{value}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one user profile for GDPR
      effect: destructive
      questions:
      - How do I honor a right-to-be-forgotten request for a single customer?
      - Can I delete one entire user profile?
      instructions:
      - text: Delete the {table} profile of the user whose {key} is {value}.
        slots:
          table: path.table
          key: path.key
          value: path.value
      - text: Erase user profile {table} {key} = {value} under GDPR.
        slots:
          table: path.table
          key: path.key
          value: path.value
      method: generated
      generated: '2026-10-02'