API Evangelist conversational phrasing for Gainsight PX REST External Segments API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Gainsight PX REST External Segments API
  version: 1.0.0
extends: openapi/gainsight-externalsegments-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: 3
- target: $.paths['/v1/external_segment/metadata'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an external segment
      effect: write
      questions:
      - Can I rename an external segment or change its description?
      - Is it possible to edit the metadata of a segment synced from outside?
      instructions:
      - text: Rename external segment {id} to {name}.
        slots:
          id: requestBody.id
          name: requestBody.name
      - text: Update the description of external segment {externalId} to {description}.
        slots:
          externalId: requestBody.externalId
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/external_segment/metadata'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an external segment
      effect: write
      questions:
      - How do I register a segment defined in another system?
      - Can creating an external segment fail if it already exists?
      instructions:
      - text: Create an external segment named {name} with external ID {externalId}.
        slots:
          name: requestBody.name
          externalId: requestBody.externalId
      - text: Register segment {name}, failing if it exists ({failIfExists}).
        slots:
          name: requestBody.name
          failIfExists: query.failIfExists
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/external_segment/update_membership'].post
  update:
    x-apievangelist-phrasing:
      intent: Change external segment membership
      effect: write
      questions:
      - What's the way to add users to, or drop them from, an external segment?
      - Can I update segment membership by account instead of by user?
      instructions:
      - text: Add identities to segments {add} and remove them from {remove}.
        slots:
          add: requestBody.add
          remove: requestBody.remove
      - text: 'Update {identityType} membership: add {add}, remove {remove}.'
        slots:
          identityType: requestBody.identityType
          add: requestBody.add
          remove: requestBody.remove
      method: generated
      generated: '2026-09-26'