# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Adobe Analytics Segments API
  version: 1.0.0
extends: openapi/adobe-analytics-segments-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['/segments'].get
  update:
    x-apievangelist-phrasing:
      intent: List segments
      effect: read
      questions:
      - What segments exist in my Adobe Analytics company?
      - Can I fetch only specific segments by ID?
      - How do I page through segments and expand their definitions?
      instructions:
      - text: List all segments.
      - text: List segments with IDs {filterByIds}.
        slots:
          filterByIds: query.filterByIds
      - text: List segments {limit} per page, page {page}, expanding {expansion}.
        slots:
          limit: query.limit
          page: query.page
          expansion: query.expansion
      method: generated
      generated: '2026-10-01'
- target: $.paths['/segments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a segment
      effect: write
      questions:
      - How do I create a segment of visitors who match certain criteria?
      - Can I create a segment for a specific report suite with a description?
      instructions:
      - text: Create segment {name} on report suite {rsid} with definition {definition}.
        slots:
          name: requestBody.name
          rsid: requestBody.rsid
          definition: requestBody.definition
      - text: Build a new segment {name} described as {description} for {rsid} using {definition}.
        slots:
          name: requestBody.name
          description: requestBody.description
          rsid: requestBody.rsid
          definition: requestBody.definition
      method: generated
      generated: '2026-10-01'
- target: $.paths['/segments/{segmentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a segment
      effect: read
      questions:
      - How do I see the definition of one segment?
      - What metadata comes back for a segment by its ID?
      instructions:
      - text: Get segment {segmentId}.
        slots:
          segmentId: path.segmentId
      - text: Show segment {segmentId} with {expansion} expanded.
        slots:
          segmentId: path.segmentId
          expansion: query.expansion
      method: generated
      generated: '2026-10-01'
- target: $.paths['/segments/{segmentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a segment
      effect: write
      questions:
      - Can I change only the name of an existing segment?
      - Which segment fields can't be edited, like tags or compatibility?
      instructions:
      - text: Rename existing segment {segmentId} to {name} on {rsid} keeping definition {definition}.
        slots:
          segmentId: path.segmentId
          name: requestBody.name
          rsid: requestBody.rsid
          definition: requestBody.definition
      - text: Change the definition of segment {segmentId} to {definition}.
        slots:
          segmentId: path.segmentId
          definition: requestBody.definition
      method: generated
      generated: '2026-10-01'
- target: $.paths['/segments/{segmentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a segment
      effect: destructive
      questions:
      - How do I permanently remove a segment?
      - Can a deleted segment be recovered?
      instructions:
      - text: Delete segment {segmentId}.
        slots:
          segmentId: path.segmentId
      - text: Permanently remove segment {segmentId}.
        slots:
          segmentId: path.segmentId
      method: generated
      generated: '2026-10-01'