# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Converis Web Services Administration - User data API
  version: 1.0.0
extends: openapi/clarivate-administration-user-data-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: 5
- target: $.paths['/admin/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List Converis users
      effect: read
      questions:
      - How do I list every user in our Converis system?
      - Can I list only the Converis users who hold a particular role?
      instructions:
      - text: List all Converis users.
      - text: List Converis users with role {role}.
        slots:
          role: query.role
      - text: Show {count} users of type {type} starting at record {startRecord}.
        slots:
          count: query.count
          type: query.type
          startRecord: query.startRecord
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/users'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Converis user
      effect: write
      questions:
      - How do I add a new user account to Converis with roles?
      - Does a new internal user get their password by email?
      instructions:
      - text: Create Converis user {userName} with email {email}.
        slots:
          userName: requestBody.userName
          email: requestBody.email
      - text: Add user {firstName} {lastName} ({email}) with roles {roles}.
        slots:
          firstName: requestBody.firstName
          lastName: requestBody.lastName
          email: requestBody.email
          roles: requestBody.roles
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/users/{username}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Converis user by username
      effect: read
      questions:
      - Where do I see the account details for one Converis user?
      - What roles and settings does a given username have?
      instructions:
      - text: Show Converis user {username}.
        slots:
          username: path.username
      - text: Get the account details and roles of {username}.
        slots:
          username: path.username
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/users/{username}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Converis user
      effect: write
      questions:
      - How do I change an existing Converis user's email or roles?
      - If I leave roles out of the update, are the user's current roles kept?
      instructions:
      - text: Update Converis user {username} to email {email}.
        slots:
          username: path.username
          email: requestBody.email
      - text: Replace the roles of user {username} with {roles}.
        slots:
          username: path.username
          roles: requestBody.roles
      - text: Deactivate Converis user {username} by setting active to {active}.
        slots:
          username: path.username
          active: requestBody.active
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/users/{username}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Converis user
      effect: destructive
      questions:
      - How do I remove a user and their roles from Converis?
      - Is deleting a Converis user permanent?
      instructions:
      - text: Delete Converis user {username}.
        slots:
          username: path.username
      - text: Remove {username} and all of their roles.
        slots:
          username: path.username
      method: generated
      generated: '2026-10-01'