# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Mapp Engage public Group Attributes API
  version: 1.0.0
extends: openapi/mapp-group-attributes-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: 8
- target: $.paths['/groupAttributes/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a group attribute
      effect: write
      questions:
      - How do I add a new attribute definition to a group?
      - Can I add a custom field that only exists on one group?
      instructions:
      - text: Create a new attribute on group {groupId}.
        slots:
          groupId: query.groupId
      - text: Add a StoreRegion attribute to group {groupId}.
        slots:
          groupId: query.groupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groupAttributes/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete group attributes by name
      effect: destructive
      questions:
      - Can I delete several group attributes at once by name?
      - How do I remove attributes from a group's definition?
      instructions:
      - text: Delete these named attributes from group {groupId}.
        slots:
          groupId: query.groupId
      - text: Remove the obsolete attributes from group {groupId}.
        slots:
          groupId: query.groupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groupAttributes/get'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a group attribute by name
      effect: read
      questions:
      - What's the definition of one named attribute on a group?
      - Can I look up a single group attribute by its name?
      instructions:
      - text: Get attribute {attributeName} on group {groupId}.
        slots:
          attributeName: query.attributeName
          groupId: query.groupId
      - text: Show the {attributeName} group attribute.
        slots:
          attributeName: query.attributeName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groupAttributes/importAttributes'].post
  update:
    x-apievangelist-phrasing:
      intent: Import group attributes from CSV
      effect: write
      questions:
      - Can I bulk load group attributes from a CSV file?
      - Which sync mode should a CSV group attribute import use to merge or replace?
      instructions:
      - text: Import this CSV of attributes into group {groupId}.
        slots:
          groupId: query.groupId
      - text: Import group attributes to {groupId} using sync mode {syncMode}.
        slots:
          groupId: query.groupId
          syncMode: query.syncMode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groupAttributes/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List a group's attribute definitions
      effect: read
      questions:
      - Which attribute definitions exist for a particular group?
      - Can I list every attribute defined on one group?
      instructions:
      - text: List the attribute definitions for group {groupId}.
        slots:
          groupId: query.groupId
      - text: Show all attributes defined on group {groupId}.
        slots:
          groupId: query.groupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groupAttributes/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a group's attributes to CSV
      effect: read
      questions:
      - Can I export a group's attribute definitions as a CSV?
      - Is the group attribute CSV export asynchronous?
      instructions:
      - text: Export the attributes of group {groupId} to CSV.
        slots:
          groupId: query.groupId
      - text: Start a CSV export of group {groupId}'s attributes.
        slots:
          groupId: query.groupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groupAttributes/update'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a group attribute definition
      effect: write
      questions:
      - Can I change an existing group attribute definition?
      - How do I edit an attribute defined on a group?
      instructions:
      - text: Update the attribute definition on group {groupId}.
        slots:
          groupId: query.groupId
      - text: Change the description of an attribute in group {groupId}.
        slots:
          groupId: query.groupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groupAttributes/validateName'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a group attribute name is unique
      effect: read
      questions:
      - Is an attribute name already used within a group?
      - Can I check a group attribute name before creating it?
      instructions:
      - text: Check whether {name} is free as an attribute name in group {groupId}.
        slots:
          name: query.name
          groupId: query.groupId
      - text: Validate group attribute name {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'