# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Mx Technologies Users API
  version: 1.0.0
extends: openapi/mx-technologies-users-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 8
- target: $.paths['/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List the users you have created
      effect: read
      questions:
      - Which end users have I created on the MX platform?
      - Can I find a user by their email address or my own ID?
      - Is there a way to list only disabled users?
      instructions:
      - text: List all my users.
      - text: Find the user with email {email}.
        slots:
          email: query.email
      - text: Show users where disabled is {is_disabled}.
        slots:
          is_disabled: query.is_disabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new end user
      effect: write
      questions:
      - How do I register a new end user before connecting their bank?
      - What do I get back after creating a user that I need for later calls?
      instructions:
      - text: Create a user with {user}.
        slots:
          user: requestBody.user
      - text: Register a new end user with details {user} and return their GUID.
        slots:
          user: requestBody.user
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a user by MX GUID
      effect: read
      questions:
      - How do I look up a user's attributes when I have their MX-assigned GUID?
      - Is a given MX user GUID disabled or active?
      instructions:
      - text: Get user GUID {user}.
        slots:
          user: path.user_guid
      - text: Show the profile of MX user {user} using the GUID path.
        slots:
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a user by MX GUID
      effect: write
      questions:
      - How do I change a user's email or metadata using their MX GUID?
      - Can I disable a user through the GUID-based update?
      instructions:
      - text: Update user GUID {user} with {changes}.
        slots:
          user: path.user_guid
          changes: requestBody.user
      - text: Edit MX user {user}'s attributes on the GUID endpoint.
        slots:
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Permanently delete a user by MX GUID
      effect: destructive
      questions:
      - How do I permanently remove a user and their data using the MX user GUID?
      - Can a deleted user be restored afterwards?
      instructions:
      - text: Delete user GUID {user}.
        slots:
          user: path.user_guid
      - text: Permanently remove MX user {user} via the GUID path.
        slots:
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a user on the versioned API
      effect: read
      questions:
      - How do I read a user by the ID I assigned them in my own system?
      - Can I fetch a user's attributes through the versioned users endpoint?
      instructions:
      - text: Read user {user} on API version {api_version}.
        slots:
          user: path.user_identifier
          api_version: header.Accept-Version
      - text: Look up my user ID {user}.
        slots:
          user: path.user_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_identifier}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a user on the versioned API
      effect: write
      questions:
      - How do I update a user referenced by my own user ID?
      - Which user attributes can I change through the versioned endpoint?
      instructions:
      - text: Update user {user} with {changes} on API version {api_version}.
        slots:
          user: path.user_identifier
          changes: requestBody.user
          api_version: header.Accept-Version
      - text: Change my user ID {user}'s details to {changes}.
        slots:
          user: path.user_identifier
          changes: requestBody.user
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user on the versioned API
      effect: destructive
      questions:
      - How do I permanently delete a user I identify with my own ID?
      - What response comes back when a user is deleted on the versioned API?
      instructions:
      - text: Delete user {user} on API version {api_version}.
        slots:
          user: path.user_identifier
          api_version: header.Accept-Version
      - text: Permanently remove my user ID {user} and all their data.
        slots:
          user: path.user_identifier
      method: generated
      generated: '2026-09-26'