# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for V1 Lytics Segment Collection API
  version: 1.0.0
extends: openapi/lytics-segmentcollection-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['/api/segmentcollection'].get
  update:
    x-apievangelist-phrasing:
      intent: List segment collections
      effect: read
      questions:
      - Which segment collections exist on my account?
      - Can I include the member segments when listing collections?
      instructions:
      - text: List my segment collections.
      - text: 'Show segment collections with sideloaded segments: {sideload}.'
        slots:
          sideload: query.sideload
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/segmentcollection'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a segment collection
      effect: write
      questions:
      - Can I group existing segments into a named collection?
      - What do I need to make a new segment collection?
      instructions:
      - text: Create segment collection {name} from segments {collection}.
        slots:
          name: requestBody.name
          collection: requestBody.collection
      - text: Make a new collection called {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/segmentcollection/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a segment collection
      effect: read
      questions:
      - Can I fetch one segment collection by slug?
      - Which segments are in a given collection?
      instructions:
      - text: Show segment collection {id}.
        slots:
          id: path.id
      - text: 'Fetch collection {id} with its segments sideloaded: {sideload}.'
        slots:
          id: path.id
          sideload: query.sideload
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/segmentcollection/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a segment collection
      effect: write
      questions:
      - Can I rename a segment collection or change its segments?
      - Is it possible to edit an existing collection?
      instructions:
      - text: Rename segment collection {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set the segments in collection {id} to {collection}.
        slots:
          id: path.id
          collection: requestBody.collection
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/segmentcollection/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a segment collection
      effect: destructive
      questions:
      - Can I delete a segment collection?
      - Is a collection removable without touching its segments?
      instructions:
      - text: Delete segment collection {id}.
        slots:
          id: path.id
      - text: Remove collection {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'