# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Atlassian The Confluence Cloud REST Group API
  version: 1.0.0
extends: openapi/atlassian-group-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: 15
- target: $.paths['/wiki/rest/api/group'].get
  update:
    x-apievangelist-phrasing:
      intent: List Confluence user groups
      effect: read
      questions:
      - How do I list all the user groups on my Confluence site?
      - Can I page through Confluence groups alphabetically?
      instructions:
      - text: List all Confluence user groups.
      - text: List up to {limit} Confluence groups with access type {accessType}.
        slots:
          limit: query.limit
          accessType: query.accessType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/group'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Confluence user group
      effect: write
      questions:
      - How do I create a new user group in Confluence?
      - Do I need to be a site admin to add a Confluence group?
      instructions:
      - text: Create a Confluence group called {name}.
        slots:
          name: requestBody.name
      - text: Add a new user group named {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/group'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a group by name
      effect: destructive
      questions:
      - How do I delete a Confluence group when I only know its name?
      - Can I remove a user group by name rather than id?
      instructions:
      - text: Delete the Confluence group named {name}.
        slots:
          name: query.name
      - text: Remove group {name} by its name.
        slots:
          name: query.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/group/by-name'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a group by name
      effect: read
      questions:
      - How do I get a Confluence group's details from its name?
      - Can I look up a group by name passed as a query parameter?
      instructions:
      - text: Get the Confluence group whose name is {name}.
        slots:
          name: query.name
      - text: Look up group {name} using the by-name lookup.
        slots:
          name: query.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/group/by-id'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a group by id
      effect: read
      questions:
      - How do I fetch a Confluence group using its group id?
      - Can I resolve a group id to the group's name?
      instructions:
      - text: Get the Confluence group with id {id}.
        slots:
          id: query.id
      - text: Resolve group id {id} to its group details.
        slots:
          id: query.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/group/by-id'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a group by id
      effect: destructive
      questions:
      - How do I delete a Confluence group using its id?
      - Can a site admin remove a group by group id?
      instructions:
      - text: Delete the Confluence group with id {id}.
        slots:
          id: query.id
      - text: Remove group id {id} from the site.
        slots:
          id: query.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/group/{groupName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a group by name (older path form)
      effect: read
      questions:
      - Is there a deprecated lookup that returns group details from a name placed in the URL?
      - How do I fetch a group with the legacy group-name path?
      instructions:
      - text: Get group {groupName} using the legacy path endpoint.
        slots:
          groupName: path.groupName
      - text: Fetch the older by-path record for group {groupName}.
        slots:
          groupName: path.groupName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/group/member'].get
  update:
    x-apievangelist-phrasing:
      intent: List group members by group name
      effect: read
      questions:
      - Who are the members of a Confluence group I know by name?
      - Can I get the total count of members in a named group?
      instructions:
      - text: List the members of group {name}.
        slots:
          name: query.name
      - text: Show up to {limit} members of group {name} with the total size.
        slots:
          limit: query.limit
          name: query.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/group/{groupName}/member'].get
  update:
    x-apievangelist-phrasing:
      intent: List group members (older path form)
      effect: read
      questions:
      - How do I list a group's members with the legacy path-based endpoint?
      - Which members does a group have when I pass its name in the URL of the legacy members call?
      instructions:
      - text: List members of {groupName} via the legacy path endpoint.
        slots:
          groupName: path.groupName
      - text: Page through members of group {groupName} starting at {start} using the older path.
        slots:
          groupName: path.groupName
          start: query.start
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/group/picker'].get
  update:
    x-apievangelist-phrasing:
      intent: Search groups by partial name
      effect: read
      questions:
      - How do I find Confluence groups when I only know part of the name?
      - Can I autocomplete group names from a few letters?
      instructions:
      - text: Search groups matching {query}.
        slots:
          query: query.query
      - text: Find up to {limit} groups whose names contain {query}.
        slots:
          limit: query.limit
          query: query.query
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/group/userByGroupId'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a user to a group by group id
      effect: write
      questions:
      - How do I add someone to a Confluence group using the group id?
      - Can I add a member by account id to a group I know only by id?
      instructions:
      - text: Add user {accountId} to group id {groupId}.
        slots:
          accountId: requestBody.accountId
          groupId: query.groupId
      - text: Put account {accountId} into the group with id {groupId}.
        slots:
          accountId: requestBody.accountId
          groupId: query.groupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/group/userByGroupId'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user from a group by group id
      effect: destructive
      questions:
      - How do I take a user out of a Confluence group using the group id?
      - Can I remove a member by account id from a group identified by id?
      instructions:
      - text: Remove user {accountId} from group id {groupId}.
        slots:
          accountId: query.accountId
          groupId: query.groupId
      - text: Drop a member from the group with id {groupId}.
        slots:
          groupId: query.groupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/group/{groupId}/membersByGroupId'].get
  update:
    x-apievangelist-phrasing:
      intent: List group members by group id
      effect: read
      questions:
      - How do I list who belongs to a group when I have its group id?
      - Can I count members of a group identified by id?
      instructions:
      - text: List members of group id {groupId}.
        slots:
          groupId: path.groupId
      - text: Show {limit} members of group id {groupId} including the total.
        slots:
          limit: query.limit
          groupId: path.groupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/group/user'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a user to a group by group name
      effect: write
      questions:
      - How do I add a user to a Confluence group by its name?
      - Who is allowed to add members to a named group?
      instructions:
      - text: Add user {accountId} to the group named {name}.
        slots:
          accountId: requestBody.accountId
          name: query.name
      - text: Make account {accountId} a member of group {name}.
        slots:
          accountId: requestBody.accountId
          name: query.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/group/user'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user from a group by group name
      effect: destructive
      questions:
      - How do I remove someone from a Confluence group by the group's name?
      - Can I take a member out of a named group using their account id?
      instructions:
      - text: Remove user {accountId} from the group named {name}.
        slots:
          accountId: query.accountId
          name: query.name
      - text: Take a member out of group {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-10-01'