API Evangelist conversational phrasing for Jira Cloud platform REST Groups API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Jira Cloud platform REST Groups API
  version: 1.0.0
extends: openapi/jira-groups-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['/rest/api/3/group'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a group and its users (deprecated)
      effect: read
      questions:
      - Is there an older endpoint that returns a group together with its users?
      - Can I look up a group by name using the deprecated group call?
      instructions:
      - text: Get group {groupname} using the deprecated group endpoint.
        slots:
          groupname: query.groupname
      - text: Show the legacy group record for group ID {groupId}.
        slots:
          groupId: query.groupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/group'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a user group
      effect: write
      questions:
      - How do I create a new group of users in Jira?
      - Who is allowed to create groups?
      instructions:
      - text: Create a group named {name}.
        slots:
          name: requestBody.name
      - text: Add a new user group {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/group'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a group
      effect: destructive
      questions:
      - How do I delete a group and move its permissions to another group?
      - Can I remove a group by its ID instead of its name?
      instructions:
      - text: Delete group {groupname}.
        slots:
          groupname: query.groupname
      - text: Remove group {groupId} and swap its restrictions to {swapGroupId}.
        slots:
          groupId: query.groupId
          swapGroupId: query.swapGroupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/group/bulk'].get
  update:
    x-apievangelist-phrasing:
      intent: List groups in bulk
      effect: read
      questions:
      - Can I get a paginated list of all groups on my site?
      - Which groups grant access to a particular application?
      instructions:
      - text: List groups with names {groupName}.
        slots:
          groupName: query.groupName
      - text: Show groups with {accessType} access to application {applicationKey}.
        slots:
          accessType: query.accessType
          applicationKey: query.applicationKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/group/member'].get
  update:
    x-apievangelist-phrasing:
      intent: List members of a group
      effect: read
      questions:
      - Who are the members of a given group?
      - Can I include inactive users when listing a group's members?
      instructions:
      - text: List the members of group {groupname}.
        slots:
          groupname: query.groupname
      - text: 'Show all users in group {groupId}, including inactive ones: {includeInactiveUsers}.'
        slots:
          groupId: query.groupId
          includeInactiveUsers: query.includeInactiveUsers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/group/user'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a user to a group
      effect: write
      questions:
      - How do I add someone to a group?
      - Do I need site admin rights to add a user to a group?
      instructions:
      - text: Add user {accountId} to group {groupname}.
        slots:
          accountId: requestBody.accountId
          groupname: query.groupname
      - text: Put {accountId} into group ID {groupId}.
        slots:
          accountId: requestBody.accountId
          groupId: query.groupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/group/user'].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 someone from a group using their account ID?
      instructions:
      - text: Remove user {accountId} from group {groupname}.
        slots:
          accountId: query.accountId
          groupname: query.groupname
      - text: Take {accountId} out of group ID {groupId}.
        slots:
          accountId: query.accountId
          groupId: query.groupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/groups/picker'].get
  update:
    x-apievangelist-phrasing:
      intent: Search groups by name for a picker
      effect: read
      questions:
      - Which groups have names containing a given word?
      - Can I exclude certain groups from group picker suggestions?
      instructions:
      - text: Find groups whose names contain {query}.
        slots:
          query: query.query
      - text: Suggest groups matching {query}, excluding {exclude}.
        slots:
          query: query.query
          exclude: query.exclude
      method: generated
      generated: '2026-09-26'