Lytics · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Lytics User API
11 actions
11 updates
phrasing
extends
openapi/lytics-user-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.
What the actions change
x-apievangelist-phrasing
Targets 11
$.info
$.paths['/api/user/{userid}'].get
$.paths['/api/user/{userid}'].put
$.paths['/api/user'].get
$.paths['/api/user'].post
$.paths['/api/user/{userid}/setpassword'].post
$.paths['/user'].get
$.paths['/user/me/passwordreset'].post
$.paths['/user/{id}'].get
$.paths['/user/{id}'].delete
$.paths['/user/{id}/roles'].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 Lytics User API
version: 1.0.0
extends: openapi/lytics-user-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: 10
- target: $.paths['/api/user/{userid}'].get
update:
x-apievangelist-phrasing:
intent: Get an admin user
effect: read
questions:
- Can I look up one admin user on my account?
- What role does a particular admin user have?
instructions:
- text: Show admin user {userid}.
slots:
userid: path.userid
- text: Fetch the details of admin {userid}.
slots:
userid: path.userid
method: generated
generated: '2026-10-01'
- target: $.paths['/api/user/{userid}'].put
update:
x-apievangelist-phrasing:
intent: Update an admin user
effect: write
questions:
- Can I change an admin user's details or roles?
- Is it possible to edit an existing admin user?
instructions:
- text: Update admin user {userid}.
slots:
userid: path.userid
- text: Change the roles of admin {userid}.
slots:
userid: path.userid
method: generated
generated: '2026-10-01'
- target: $.paths['/api/user'].get
update:
x-apievangelist-phrasing:
intent: List admin users and roles
effect: read
questions:
- Who has admin access to my account and what roles do they have?
- Can I list every administrative user?
instructions:
- text: List my account's admin users.
- text: Show all admins and their roles.
method: generated
generated: '2026-10-01'
- target: $.paths['/api/user'].post
update:
x-apievangelist-phrasing:
intent: Invite or create an admin user
effect: write
questions:
- How do I invite a teammate to my account?
- Can I add an admin without sending them an invite email?
instructions:
- text: Invite {email} as an admin named {name}.
slots:
email: requestBody.email
name: requestBody.name
- text: Add admin user {email} with suppress set to {suppress}.
slots:
email: requestBody.email
suppress: query.suppress
method: generated
generated: '2026-10-01'
- target: $.paths['/api/user/{userid}/setpassword'].post
update:
x-apievangelist-phrasing:
intent: Set an admin user's password
effect: write
questions:
- Can I set a new password for an admin user?
- Is it possible to reset an admin's password via the API?
instructions:
- text: Set the password of admin {userid} to {password}.
slots:
userid: path.userid
password: requestBody.password
- text: Reset admin user {userid}'s password.
slots:
userid: path.userid
method: generated
generated: '2026-10-01'
- target: $.paths['/user'].get
update:
x-apievangelist-phrasing:
intent: List every user on the account
effect: read
questions:
- Which users have access to a given account, not just the admins?
- Can I pull the full user roster for one of my accounts?
instructions:
- text: List all users on account {account_id}.
slots:
account_id: query.account_id
- text: Show the full user roster for my current account.
method: generated
generated: '2026-10-02'
- target: $.paths['/user/me/passwordreset'].post
update:
x-apievangelist-phrasing:
intent: Change my own password
effect: write
questions:
- How do I change the password on my own login?
- Do I need my old password to set a new one for myself?
instructions:
- text: Change my password from {oldpassword} to {password}.
slots:
oldpassword: requestBody.oldpassword
password: requestBody.password
- text: Reset my own login password to {password}.
slots:
password: requestBody.password
method: generated
generated: '2026-10-02'
- target: $.paths['/user/{id}'].get
update:
x-apievangelist-phrasing:
intent: Look up a user by id, email or me
effect: read
questions:
- Can I look up a user by their email address instead of an id?
- Who am I authenticated as right now?
instructions:
- text: Look up the user with email or id {id}.
slots:
id: path.id
- text: Get user {id} on account {account_id}, or use me for myself.
slots:
id: path.id
account_id: query.account_id
method: generated
generated: '2026-10-02'
- target: $.paths['/user/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Remove a user's access to the account
effect: destructive
questions:
- How do I revoke someone's access to my account?
- Is a user deleted entirely once they lose their last account role?
instructions:
- text: Remove user {id} from my account.
slots:
id: path.id
- text: Revoke {id}'s access to account {account_id}.
slots:
id: path.id
account_id: query.account_id
method: generated
generated: '2026-10-02'
- target: $.paths['/user/{id}/roles'].post
update:
x-apievangelist-phrasing:
intent: Replace a user's account roles
effect: write
questions:
- Can I replace all the roles a user holds with a new set?
- Which call overwrites a user's role list rather than adding one role?
instructions:
- text: Set user {id}'s roles to exactly {roles}.
slots:
id: path.id
roles: requestBody.roles
- text: Replace every role of user {id} on account {account_id} with {roles}.
slots:
id: path.id
account_id: query.account_id
roles: requestBody.roles
method: generated
generated: '2026-10-02'