# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin Portal Group API
  version: 1.0.0
extends: openapi/strivacity-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: 5
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List groups in an identity store
      effect: read
      questions:
      - Which groups exist in an identity store?
      - Can I search groups by name or exclude certain group IDs?
      instructions:
      - text: List the groups in identity store {identityStoreName}.
        slots:
          identityStoreName: path.identityStoreName
      - text: Find groups named {name} in {identityStoreName}.
        slots:
          name: query.name
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a group
      effect: write
      questions:
      - How do I create a new group of accounts in an identity store?
      - Can I give a group a description when I create it?
      instructions:
      - text: Create a group named {name} in identity store {identityStoreName}.
        slots:
          name: requestBody.name
          identityStoreName: path.identityStoreName
      - text: Add group {name} to {identityStoreName} described as {description}.
        slots:
          name: requestBody.name
          identityStoreName: path.identityStoreName
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/groups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a group
      effect: read
      questions:
      - How do I look up a single group's details?
      - What name and description does a specific group have?
      instructions:
      - text: Show group {id} in identity store {identityStoreName}.
        slots:
          id: path.id
          identityStoreName: path.identityStoreName
      - text: Get the details of group {id} in {identityStoreName}.
        slots:
          id: path.id
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/groups/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a group
      effect: write
      questions:
      - How do I rename an existing group?
      - Can I change a group's description?
      instructions:
      - text: Rename group {id} in {identityStoreName} to {name}.
        slots:
          id: path.id
          identityStoreName: path.identityStoreName
          name: requestBody.name
      - text: Update the description of group {id} in identity store {identityStoreName} to {description}.
        slots:
          id: path.id
          identityStoreName: path.identityStoreName
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/groups/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a group
      effect: destructive
      questions:
      - Why can't I delete a group that still has members?
      - How do I remove an empty group from an identity store?
      instructions:
      - text: Delete group {id} from identity store {identityStoreName}.
        slots:
          id: path.id
          identityStoreName: path.identityStoreName
      - text: Remove the empty group {id} in {identityStoreName}.
        slots:
          id: path.id
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'