# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cohesity REST Groups API
  version: 1.0.0
extends: openapi/cohesity-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: 4
- target: $.paths['/public/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List cluster groups
      effect: read
      questions:
      - Which user groups are set up on the cluster?
      - Can I find groups by a partial name within one domain?
      instructions:
      - text: List all groups on the cluster.
      - text: Find groups named like {name} in domain {domain}.
        slots:
          name: query.name
          domain: query.domain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/groups'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a cluster group
      effect: write
      questions:
      - How do I change the roles assigned to an existing group?
      - Does updating a group on the cluster change it in Active Directory?
      instructions:
      - text: Update group {name} in {domain} to have roles {roles}.
        slots:
          name: requestBody.name
          domain: requestBody.domain
          roles: requestBody.roles
      - text: Set the members of local group {name} to {users}.
        slots:
          name: requestBody.name
          users: requestBody.users
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a group to the cluster
      effect: write
      questions:
      - How do I bring an Active Directory group onto the cluster with a role?
      - Can I create a local group with restricted access?
      instructions:
      - text: Add group {name} from domain {domain} with roles {roles}.
        slots:
          name: requestBody.name
          domain: requestBody.domain
          roles: requestBody.roles
      - text: Create a new local group {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/groups'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete groups from the cluster
      effect: destructive
      questions:
      - Can I remove several groups from the same domain at once?
      - Is the Active Directory group deleted when I remove it from the cluster?
      instructions:
      - text: Delete groups {names} from domain {domain}.
        slots:
          names: requestBody.names
          domain: requestBody.domain
      - text: Remove cluster groups {names}.
        slots:
          names: requestBody.names
      method: generated
      generated: '2026-10-01'