# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Live Direct Marketing Online Users API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-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: 15
- target: $.paths['/api/users/me/accept-terms'].post
  update:
    x-apievangelist-phrasing:
      intent: Accept the legal terms as the current user
      effect: write
      questions:
      - How do I accept the terms of service for my user?
      - Can I record that I agreed to the legal terms from my profile?
      instructions:
      - text: Accept the legal terms for my user.
      - text: Mark the terms as accepted on my own account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List platform users
      effect: read
      questions:
      - Which users are registered on the platform?
      - Can a manager page through all users?
      instructions:
      - text: List users, page {page}.
        slots:
          page: query.page
      - text: Show {pageSize} users per page.
        slots:
          pageSize: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/users'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a user
      effect: write
      questions:
      - How does a super admin create a new user?
      - Can I assign a role when I create a user?
      instructions:
      - text: Create a user {email} with password {password}.
        slots:
          email: requestBody.email
          password: requestBody.password
      - text: Add user {email} with password {password} and role {role}.
        slots:
          email: requestBody.email
          password: requestBody.password
          role: requestBody.role
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/users/system/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get system resource stats
      effect: read
      questions:
      - What are the current system stats for the platform server?
      - Can a super admin see system-level resource usage?
      instructions:
      - text: Show the system stats.
      - text: Get current server resource statistics.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/users/system/kill-process/{pid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Kill a system process
      effect: destructive
      questions:
      - Can a super admin kill a stuck process on the server?
      - How do I terminate a system process by its pid?
      instructions:
      - text: Kill system process {pid}.
        slots:
          pid: path.pid
      - text: Terminate the server process with pid {pid}.
        slots:
          pid: path.pid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/users/system/cleanup-orphans'].post
  update:
    x-apievangelist-phrasing:
      intent: Clean up orphaned system resources
      effect: destructive
      questions:
      - Can I clean up orphaned resources left on the system?
      - What removes leftover orphan processes or resources?
      instructions:
      - text: Clean up orphaned system resources.
      - text: Remove the orphan resources left on the server.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/users/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user
      effect: read
      questions:
      - What details does the platform hold for a specific user?
      - Can a manager look up one user by id?
      instructions:
      - text: Get user {id}.
        slots:
          id: path.id
      - text: Show the record for user {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/users/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user and clean up their tenants
      effect: destructive
      questions:
      - What happens to a user's tenants when I delete the user?
      - Does deleting a user drop tenants where they are the only member?
      instructions:
      - text: Delete user {id}.
        slots:
          id: path.id
      - text: Remove user {id} and clean up their sole-member tenants.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/users/{id}/role'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a user's role
      effect: write
      questions:
      - How do I promote a user to a different role?
      - Can a manager change someone's role?
      instructions:
      - text: Change the role of user {id} to {role}.
        slots:
          id: path.id
          role: requestBody.role
      - text: Give user {id} the {role} role.
        slots:
          id: path.id
          role: requestBody.role
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/users/{id}/status'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a user's status
      effect: write
      questions:
      - Can I block or reactivate a user by changing their status?
      - How do I set a user's account status?
      instructions:
      - text: Set the status of user {id} to {status}.
        slots:
          id: path.id
          status: requestBody.status
      - text: Change user {id} to status {status}.
        slots:
          id: path.id
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/users/{id}/password'].patch
  update:
    x-apievangelist-phrasing:
      intent: Set a user's password
      effect: write
      questions:
      - Can a super admin reset another user's password?
      - How do I set a new password for a user?
      instructions:
      - text: Set the password of user {id} to {password}.
        slots:
          id: path.id
          password: requestBody.password
      - text: Reset user {id}'s password to {password}.
        slots:
          id: path.id
          password: requestBody.password
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/users/{id}/profile'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a user's name
      effect: write
      questions:
      - Can I correct a user's first or last name?
      - Which profile fields can a super admin edit on a user?
      instructions:
      - text: Rename user {id} to {firstName} {lastName}.
        slots:
          id: path.id
          firstName: requestBody.firstName
          lastName: requestBody.lastName
      - text: Update the profile of user {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/users/{id}/comments'].get
  update:
    x-apievangelist-phrasing:
      intent: List admin comments on a user
      effect: read
      questions:
      - What notes have admins left about a user?
      - Can I read the internal comments on someone's account?
      instructions:
      - text: List admin comments on user {id}.
        slots:
          id: path.id
      - text: Show the internal notes about user {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/users/{id}/comments'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an admin comment on a user
      effect: write
      questions:
      - How do I leave an internal note on a user's account?
      - Can managers add comments about a user?
      instructions:
      - text: Add an admin comment to user {id}.
        slots:
          id: path.id
      - text: Leave an internal note on user {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/users/{id}/comments/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an admin comment on a user
      effect: destructive
      questions:
      - Can I remove an admin note from a user?
      - Who is allowed to delete comments on a user?
      instructions:
      - text: Delete comment {commentId} on user {id}.
        slots:
          id: path.id
          commentId: path.commentId
      - text: Remove admin note {commentId} from user {id}.
        slots:
          id: path.id
          commentId: path.commentId
      method: generated
      generated: '2026-10-01'