Contentstack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Contentstack Personalize Management Audiences API

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

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/audiences'].get
$.paths['/audiences'].post
$.paths['/audiences/{id}'].put
$.paths['/audiences/{id}'].delete

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 Contentstack Personalize Management Audiences API
  version: 1.0.0
extends: openapi/contentstack-audiences-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: 4
- target: $.paths['/audiences'].get
  update:
    x-apievangelist-phrasing:
      intent: List audience segments
      effect: read
      questions:
      - What audiences have I defined in Personalize?
      - Which audience segments can my experiences target?
      instructions:
      - text: List the audiences in Personalize project {project}.
        slots:
          project: header.x-project-uid
      - text: Show all audience segments for project {project}.
        slots:
          project: header.x-project-uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an audience segment
      effect: write
      questions:
      - How do I build an audience from attribute conditions?
      - Can I describe the purpose of an audience when creating it?
      instructions:
      - text: Create audience {name} in project {project}.
        slots:
          name: requestBody.name
          project: header.x-project-uid
      - text: Create audience {name} with rules {rules} in Personalize project {project}.
        slots:
          name: requestBody.name
          rules: requestBody.rules
          project: header.x-project-uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an audience's rules
      effect: write
      questions:
      - How do I change the rules of an existing audience?
      - Can I rename an audience segment?
      instructions:
      - text: Rename audience {id} in project {project} to {name}.
        slots:
          id: path.id
          project: header.x-project-uid
          name: requestBody.name
      - text: Change the rules of existing audience {id} ({name}) in project {project} to {rules}.
        slots:
          id: path.id
          name: requestBody.name
          project: header.x-project-uid
          rules: requestBody.rules
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an audience
      effect: destructive
      questions:
      - Can I delete an audience that an active experience still uses?
      - How do I remove an audience segment permanently?
      instructions:
      - text: Delete audience {id} from project {project}.
        slots:
          id: path.id
          project: header.x-project-uid
      - text: Permanently remove audience segment {id} in Personalize project {project}.
        slots:
          id: path.id
          project: header.x-project-uid
      method: generated
      generated: '2026-09-26'