# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Atlassian Groups API
  version: 1.0.0
extends: openapi/atlassian-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: 9
- target: $.paths['/v1/orgs/{orgId}/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List the groups in an Atlassian organization
      effect: read
      questions:
      - Which groups exist in my Atlassian organization?
      - Can I page through all org-level groups with a cursor?
      instructions:
      - text: List the groups in organization {orgId}.
        slots:
          orgId: path.orgId
      - text: Get the next page of groups for org {orgId} starting at cursor {cursor}.
        slots:
          orgId: path.orgId
          cursor: query.cursor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/group'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Jira group's members (deprecated)
      effect: read
      questions:
      - Is there an older Jira call that returns a group along with its users?
      - What does the deprecated get-group endpoint return for a group name?
      instructions:
      - text: Get Jira group {groupname} with its users using the deprecated group endpoint.
        slots:
          groupname: query.groupname
      - text: Fetch group {groupId} and expand {expand} via the legacy call.
        slots:
          groupId: query.groupId
          expand: query.expand
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/group'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Jira group
      effect: write
      questions:
      - How do I create a new user group in Jira?
      - Which permission do I need to add a group to the Jira site?
      instructions:
      - text: Create a Jira group named {name}.
        slots:
          name: requestBody.name
      - text: Add a new group called {name} to the site.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/group'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Jira group
      effect: destructive
      questions:
      - Can I delete a Jira group and move its permissions to another group?
      - What happens to a deleted group's restrictions if I name a swap group?
      instructions:
      - text: Delete Jira group {groupId}, transferring its restrictions to group {swapGroupId}.
        slots:
          groupId: query.groupId
          swapGroupId: query.swapGroupId
      - text: Remove the group named {groupname} from Jira.
        slots:
          groupname: query.groupname
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/group/bulk'].get
  update:
    x-apievangelist-phrasing:
      intent: Bulk look up Jira groups
      effect: read
      questions:
      - Can I fetch several Jira groups at once by their IDs or names?
      - Which groups have access to a particular application like Jira Software?
      instructions:
      - text: Get Jira groups with IDs {groupId}.
        slots:
          groupId: query.groupId
      - text: List groups with {accessType} access to application {applicationKey}, up to {maxResults}.
        slots:
          accessType: query.accessType
          applicationKey: query.applicationKey
          maxResults: query.maxResults
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/group/member'].get
  update:
    x-apievangelist-phrasing:
      intent: List the members of a Jira group
      effect: read
      questions:
      - Who are all the users in a given Jira group?
      - Can I include inactive users when listing a group's members?
      instructions:
      - text: List the members of Jira group {groupname}.
        slots:
          groupname: query.groupname
      - text: Show users in group {groupId}, including inactive users {includeInactiveUsers}.
        slots:
          groupId: query.groupId
          includeInactiveUsers: query.includeInactiveUsers
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/group/user'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a user to a Jira group
      effect: write
      questions:
      - How do I put a user into a Jira group?
      - Which permission is needed to add someone to a group?
      instructions:
      - text: Add user {accountId} to Jira group {groupname}.
        slots:
          accountId: requestBody.accountId
          groupname: query.groupname
      - text: Put account {accountId} into group {groupId}.
        slots:
          accountId: requestBody.accountId
          groupId: query.groupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/group/user'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user from a Jira group
      effect: destructive
      questions:
      - Can I take a user out of a Jira group without deactivating them?
      - What do I need to remove someone from a group?
      instructions:
      - text: Remove user {accountId} from Jira group {groupname}.
        slots:
          accountId: query.accountId
          groupname: query.groupname
      - text: Take account {accountId} out of group {groupId}.
        slots:
          accountId: query.accountId
          groupId: query.groupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/groups/picker'].get
  update:
    x-apievangelist-phrasing:
      intent: Search Jira groups by name for a picker
      effect: read
      questions:
      - Which Jira groups have names containing a given word?
      - Can I search groups case-insensitively and exclude some from the results?
      instructions:
      - text: Find Jira groups whose names contain {query}.
        slots:
          query: query.query
      - text: Search groups matching {query}, excluding {exclude}, case-insensitive {caseInsensitive}.
        slots:
          query: query.query
          exclude: query.exclude
          caseInsensitive: query.caseInsensitive
      method: generated
      generated: '2026-10-01'