API Evangelist conversational phrasing for 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 Groups API
  version: 1.0.0
extends: openapi/qliksense-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: 6
- target: $.paths['/api/v1/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List groups
      effect: read
      questions:
      - Which user groups exist in my Qlik Cloud tenant?
      - Can I include system groups when listing groups?
      instructions:
      - text: List the groups in my tenant.
      - text: List groups matching {filter}.
        slots:
          filter: query.filter
      - text: List groups including system groups set to {systemGroups}.
        slots:
          systemGroups: query.systemGroups
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a group
      effect: write
      questions:
      - How do I create a new user group?
      - Are group names case-sensitive, and how many groups can a tenant have?
      instructions:
      - text: Create a group named {name}.
        slots:
          name: requestBody.name
      - text: Create group {name} with roles {assignedRoles}.
        slots:
          name: requestBody.name
          assignedRoles: requestBody.assignedRoles
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/groups/{groupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a group
      effect: read
      questions:
      - How do I look up one group by its ID?
      - What roles are assigned to a specific group?
      instructions:
      - text: Show group {groupId}.
        slots:
          groupId: path.groupId
      - text: Get the roles assigned to group {groupId}.
        slots:
          groupId: path.groupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/groups/{groupId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a group
      effect: destructive
      questions:
      - How do I delete a user group?
      - Can I remove a group that is no longer used?
      instructions:
      - text: Delete group {groupId}.
        slots:
          groupId: path.groupId
      - text: Remove user group {groupId} from the tenant.
        slots:
          groupId: path.groupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/groups/{groupId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a group
      effect: write
      questions:
      - Can I change the roles or status of an existing group?
      - How do I edit a group's details?
      instructions:
      - text: Update group {groupId}.
        slots:
          groupId: path.groupId
      - text: Change the assigned roles on group {groupId}.
        slots:
          groupId: path.groupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/groups/actions/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Filter groups with an advanced query
      effect: read
      questions:
      - Can I search groups with an advanced query string in the request body?
      - What's the way to run a complex group filter that is too long for a URL?
      instructions:
      - text: Filter groups with the advanced query {filter}.
        slots:
          filter: requestBody.filter
      - text: Search groups using filter {filter}, returning up to {limit}.
        slots:
          filter: requestBody.filter
          limit: query.limit
      method: generated
      generated: '2026-09-26'