Treasure Data · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for cdp-api Parent Segments API

5 actions 5 updates phrasing extends openapi/treasure-data-parent-segments-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Treasure Data's API. It is a proposal applied on top of the contract, not a document Treasure Data publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/audiences/{audienceId}/folders'].get

$.paths['/master_segments'].get

$.paths['/entities/parent_segments'].get

$.paths['/entities/parent_segments/{id}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for cdp-api Parent Segments API
  version: 1.0.0
extends: openapi/treasure-data-parent-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: 4
- target: $.paths['/audiences/{audienceId}/folders'].get
  update:
    x-apievangelist-phrasing:
      intent: List segment folders in a parent segment
      effect: read
      questions:
      - What segment folders exist under a parent segment?
      - How are the segments in one audience organized into folders?
      instructions:
      - text: List the segment folders for parent segment {audienceId}.
        slots:
          audienceId: path.audienceId
      - text: Show me how segments in audience {audienceId} are grouped into folders.
        slots:
          audienceId: path.audienceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/master_segments'].get
  update:
    x-apievangelist-phrasing:
      intent: List audiences whose data I can view
      effect: read
      questions:
      - Which audiences am I allowed to see segments, profiles and activations for?
      - Can I check which master segments my user has data access to?
      instructions:
      - text: List the audiences whose produced data I can view.
      - text: Show the master segments my account has permission to see.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/parent_segments'].get
  update:
    x-apievangelist-phrasing:
      intent: List parent segments
      effect: read
      questions:
      - What parent segments are defined in my Treasure Data CDP?
      - How do I get every parent segment as an entity list?
      instructions:
      - text: List all parent segments.
      - text: Give me the full list of parent segment entities.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/parent_segments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a parent segment
      effect: read
      questions:
      - What is configured on one particular parent segment?
      - Can I retrieve a single parent segment by ID?
      instructions:
      - text: Show parent segment {id}.
        slots:
          id: path.id
      - text: Fetch the details of parent segment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'