Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Realtime Segments API

7 actions 7 updates phrasing extends openapi/optimizely-realtimesegments-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Optimizely's API. It is a proposal applied on top of the contract, not a document Optimizely publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/segments'].get
$.paths['/segments/{segment_id}'].get
$.paths['/segments/{segment_id}'].put
$.paths['/segments/{segment_id}'].post
$.paths['/segments/{segment_id}'].delete
$.paths['/segments/{segment_id}:validate'].post

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Realtime Segments API
  version: 1.0.0
extends: openapi/optimizely-realtimesegments-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: 6
- target: $.paths['/segments'].get
  update:
    x-apievangelist-phrasing:
      intent: List real-time segments
      effect: read
      questions:
      - Which real-time segments are defined in my account?
      - How do I get an overview of all my real-time audience segments?
      instructions:
      - text: List all real-time segments in my account.
      - text: Show every real-time segment we have set up.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/segments/{segment_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a real-time segment's definition
      effect: read
      questions:
      - How can I see how a real-time segment is defined?
      - Does fetching a segment return its member list, or only its schema?
      instructions:
      - text: Show the definition of real-time segment {segment_id}.
        slots:
          segment_id: path.segment_id
      - text: Get the schema of segment {segment_id}.
        slots:
          segment_id: path.segment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/segments/{segment_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an existing real-time segment
      effect: write
      questions:
      - How do I change the rules of a real-time segment that already exists?
      - Can I edit a segment's description or metadata after it's created?
      instructions:
      - text: Update segment {segment_id} to use definition {definition}.
        slots:
          segment_id: path.segment_id
          definition: requestBody.definition
      - text: Change the description of existing segment {segment_id} to {description}.
        slots:
          segment_id: path.segment_id
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/segments/{segment_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new real-time segment
      effect: write
      questions:
      - How do I create a new real-time audience segment?
      - What goes into a brand-new segment besides its definition?
      instructions:
      - text: Create new segment {segment_id} with definition {definition}.
        slots:
          segment_id: path.segment_id
          definition: requestBody.definition
      - text: Create real-time segment {segment_id} described as {description} with metadata {metadata}.
        slots:
          segment_id: path.segment_id
          description: requestBody.description
          metadata: requestBody.metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/segments/{segment_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a real-time segment
      effect: destructive
      questions:
      - How do I remove a real-time segment I no longer need?
      - Will deleting a segment also delete the customers in it?
      instructions:
      - text: Delete real-time segment {segment_id}.
        slots:
          segment_id: path.segment_id
      - text: Remove segment {segment_id} from the account.
        slots:
          segment_id: path.segment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/segments/{segment_id}:validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a segment definition
      effect: read
      questions:
      - Can I check a segment definition for errors before saving it?
      - Is there a dry-run to test whether my segment rules are valid?
      instructions:
      - text: Validate definition {definition} for segment {segment_id} without saving.
        slots:
          segment_id: path.segment_id
          definition: requestBody.definition
      - text: Check that segment {segment_id} has a valid definition.
        slots:
          segment_id: path.segment_id
      method: generated
      generated: '2026-09-26'