# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Confluence Cloud REST Group API
  version: 1.0.0
extends: openapi/confluence-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: 8
- target: $.paths['/wiki/rest/api/group'].get
  update:
    x-apievangelist-phrasing:
      intent: List user groups
      effect: read
      questions:
      - What user groups exist on my Confluence site?
      - Are groups returned in alphabetical order?
      instructions:
      - text: List all user groups on the site.
      - text: List the first {limit} groups alphabetically.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/group'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a 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 group?
      instructions:
      - text: Create a user group called {name}.
        slots:
          name: requestBody.name
      - text: Add a new group named {name} to the site.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/group/by-id'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a group by its id
      effect: read
      questions:
      - Can I look up a group's details from its group id?
      - What does a single user group record contain?
      instructions:
      - text: Show the group with id {id}.
        slots:
          id: query.id
      - text: Fetch details of user group {id}.
        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 user group
      effect: destructive
      questions:
      - How do I delete a user group I no longer need?
      - Who is allowed to remove a group from the site?
      instructions:
      - text: Delete the user group with id {id}.
        slots:
          id: query.id
      - text: Remove group {id} from the site entirely.
        slots:
          id: query.id
      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:
      - Can I find groups by typing just part of their name?
      - Is there a way to get the total count of groups matching a search?
      instructions:
      - text: Search for groups whose name matches {query}.
        slots:
          query: query.query
      - text: Find up to {limit} groups matching {query}.
        slots:
          limit: query.limit
          query: query.query
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/group/{groupId}/membersByGroupId'].get
  update:
    x-apievangelist-phrasing:
      intent: List the members of a group
      effect: read
      questions:
      - Who are the users in a particular Confluence group?
      - Can I get the total member count along with a group's users?
      instructions:
      - text: List the members of group {groupId}.
        slots:
          groupId: path.groupId
      - text: Show the first {limit} users in group {groupId}.
        slots:
          limit: query.limit
          groupId: path.groupId
      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
      effect: write
      questions:
      - How do I add someone to a Confluence group?
      - Can I add a member to a group using their account id?
      instructions:
      - text: Add user {accountId} to group {groupId}.
        slots:
          accountId: requestBody.accountId
          groupId: query.groupId
      - text: Make account {accountId} a member of group {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
      effect: destructive
      questions:
      - How do I take a user out of a group?
      - Does removing someone from a group require site admin rights?
      instructions:
      - text: Remove user {accountId} from group {groupId}.
        slots:
          accountId: query.accountId
          groupId: query.groupId
      - text: Revoke group {groupId} membership for account {accountId}.
        slots:
          groupId: query.groupId
          accountId: query.accountId
      method: generated
      generated: '2026-10-01'