# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for MOVEit Transfer REST Groups API
  version: 1.0.0
extends: openapi/progress-software-groups-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['/api/v1/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List user groups I can view
      effect: read
      questions:
      - Which MOVEit Transfer user groups can I see?
      - Can I page through the list of groups?
      instructions:
      - text: List the groups I can view.
      - text: Show page {page} of groups, {perPage} per page.
        slots:
          page: query.page
          perPage: query.perPage
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a user group
      effect: write
      questions:
      - How do I create a new group to organize users?
      - Can I give a new group a description when I create it?
      instructions:
      - text: Create a group named {name}.
        slots:
          name: requestBody.name
      - text: Create group {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/groups/{Id}/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List the members of a group
      effect: read
      questions:
      - Who is in a particular group?
      - Can I page through a large group's membership list?
      instructions:
      - text: List the members of group {Id}.
        slots:
          Id: path.Id
      - text: Show page {page} of members in group {Id}.
        slots:
          page: query.page
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/groups/{Id}/members'].post
  update:
    x-apievangelist-phrasing:
      intent: Add users to a group
      effect: write
      questions:
      - How do I add several users to a group at once?
      - Can I put a new user into an existing group?
      instructions:
      - text: Add users {userIds} to group {Id}.
        slots:
          userIds: requestBody.userIds
          Id: path.Id
      - text: 'Put these users into group {Id}: {userIds}.'
        slots:
          Id: path.Id
          userIds: requestBody.userIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/groups/{Id}/members/{UserId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user from a group
      effect: destructive
      questions:
      - How do I take a user out of a group?
      - Can I remove one member without deleting the group?
      instructions:
      - text: Remove user {UserId} from group {Id}.
        slots:
          UserId: path.UserId
          Id: path.Id
      - text: Drop member {UserId} from group {Id}.
        slots:
          UserId: path.UserId
          Id: path.Id
      method: generated
      generated: '2026-10-01'