# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Statsig Users API
  version: 1.0.0
extends: openapi/statsig-users-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: 11
- target: $.paths['/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users known to the project
      effect: read
      questions:
      - Which users does my Statsig project know about?
      - Can I page through the project's users a batch at a time?
      instructions:
      - text: List the users in my project.
      - text: Show page {page} of users, {limit} per page.
        slots:
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/console/v1/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List company members, including stale ones
      effect: read
      questions:
      - Can I include former or stale members when listing users?
      - Who are all the members of our company account?
      instructions:
      - text: 'List company members, including stale memberships: {include_stale_members}.'
        slots:
          include_stale_members: query.include_stale_members
      - text: Show console users page {page}, {limit} at a time.
        slots:
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/users/{email}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a user by email
      effect: read
      questions:
      - What role does a particular teammate have, given their email?
      - Can I find a user's profile from their email address?
      instructions:
      - text: Look up the user with email {email}.
        slots:
          email: path.email
      - text: Show me the role and name of {email}.
        slots:
          email: path.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/users/{email}'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a user's role or name
      effect: write
      questions:
      - How do I promote a teammate to Admin?
      - Can I set a user to Read Only or a custom role?
      instructions:
      - text: Change {email}'s role to {role}.
        slots:
          email: path.email
          role: requestBody.role
      - text: Update the name on {email} to {firstName} {lastName}.
        slots:
          email: path.email
          firstName: requestBody.firstName
          lastName: requestBody.lastName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/users/id/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a user by ID
      effect: read
      questions:
      - Which person does a given user ID in the audit trail belong to?
      - Can I resolve a user ID into a name and email?
      instructions:
      - text: Get the user with ID {id}.
        slots:
          id: path.id
      - text: Tell me who user ID {id} is.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/users/invite'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite users with a role and teams
      effect: write
      questions:
      - How do I invite several colleagues at once with the same role?
      - Do invitees get an email, or only an in-app notification?
      - Must invited emails share our company's domain?
      instructions:
      - text: Invite {emails} as {role}.
        slots:
          emails: requestBody.emails
          role: requestBody.role
      - text: Invite {emails} with role {role} and add them to teams {teams}.
        slots:
          emails: requestBody.emails
          role: requestBody.role
          teams: requestBody.teams
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/users/teams'].get
  update:
    x-apievangelist-phrasing:
      intent: List teams
      effect: read
      questions:
      - What teams exist in our organization?
      - Can I page through all the teams?
      instructions:
      - text: List all teams.
      - text: Show teams page {page} with {limit} per page.
        slots:
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/users/teams'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a team
      effect: write
      questions:
      - How do I set up a new team with members and admins?
      - Can a team require reviews before its configs change?
      - What default metrics can I give a new team?
      instructions:
      - text: Create team {name} with members {members} and admins {admins}.
        slots:
          name: requestBody.name
          members: requestBody.members
          admins: requestBody.admins
      - text: Create team {name} where review approval is {reviewApproval} and config changes are allowed by {changeTeamConfigs}.
        slots:
          name: requestBody.name
          reviewApproval: requestBody.reviewApproval
          changeTeamConfigs: requestBody.changeTeamConfigs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/users/teams/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one team's details
      effect: read
      questions:
      - Who are the members and admins of a specific team?
      - What review rules does one team enforce?
      instructions:
      - text: Show team {id}.
        slots:
          id: path.id
      - text: Get the members, admins and defaults of team {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/users/teams/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a team
      effect: destructive
      questions:
      - Can I remove a team we no longer use?
      - Is deleting a team permanent?
      instructions:
      - text: Delete team {id}.
        slots:
          id: path.id
      - text: Remove the team with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/users/teams/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a team's definition
      effect: write
      questions:
      - Does updating a team overwrite fields I leave out?
      - How can I change who belongs to an existing team?
      instructions:
      - text: Set the members of team {id} to {members}.
        slots:
          id: path.id
          members: requestBody.members
      - text: Rename team {id} to {name} and set its description to {description}.
        slots:
          id: path.id
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-10-01'