Contentstack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Contentstack Personalize Management Experiences API

8 actions 8 updates phrasing extends openapi/contentstack-experiences-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 8

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

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 Experiences API
  version: 1.0.0
extends: openapi/contentstack-experiences-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: 7
- target: $.paths['/experiences'].get
  update:
    x-apievangelist-phrasing:
      intent: List personalization experiences
      effect: read
      questions:
      - Which experiences are set up in my Personalize project?
      - How do I see all experiences with their variants and audiences?
      instructions:
      - text: List the experiences in Personalize project {project}.
        slots:
          project: header.x-project-uid
      - text: Show every experience and its audience assignments for project {project}.
        slots:
          project: header.x-project-uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/experiences'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a segmented or A/B test experience
      effect: write
      questions:
      - How do I set up an A/B test in Contentstack Personalize?
      - Can I create a rule-based segmented experience instead of a split test?
      instructions:
      - text: Create a {type} experience named {name} in project {project}.
        slots:
          type: requestBody.type
          name: requestBody.name
          project: header.x-project-uid
      - text: Create experience {name} of type {type} with variants {variants} in project {project}.
        slots:
          name: requestBody.name
          type: requestBody.type
          variants: requestBody.variants
          project: header.x-project-uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/experiences/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one experience's configuration
      effect: read
      questions:
      - How can I check the status and variants of a single experience?
      - What audiences is a particular experience targeting?
      instructions:
      - text: Show experience {id} in project {project}.
        slots:
          id: path.id
          project: header.x-project-uid
      - text: Get the variants and status of experience {id} in Personalize project {project}.
        slots:
          id: path.id
          project: header.x-project-uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/experiences/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an experience's variants or targeting
      effect: write
      questions:
      - Can I change the variants on an experience that already exists?
      - How do I edit the audience targeting of an existing experience?
      instructions:
      - text: Update experience {id} in project {project} to name {name} and type {type}.
        slots:
          id: path.id
          project: header.x-project-uid
          name: requestBody.name
          type: requestBody.type
      - text: Replace the variants of experience {id} ({name}, {type}) with {variants} in project {project}.
        slots:
          id: path.id
          name: requestBody.name
          type: requestBody.type
          variants: requestBody.variants
          project: header.x-project-uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/experiences/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an experience
      effect: destructive
      questions:
      - Can I delete an experience while it is still active?
      - How do I remove a draft experience from Personalize?
      instructions:
      - text: Delete experience {id} from project {project}.
        slots:
          id: path.id
          project: header.x-project-uid
      - text: Permanently remove the inactive experience {id} in Personalize project {project}.
        slots:
          id: path.id
          project: header.x-project-uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/experiences/priority'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the experience priority order
      effect: read
      questions:
      - Which experience wins when a visitor qualifies for more than one?
      - Where can I see the current priority ranking of active experiences?
      instructions:
      - text: Show the experience priority order for project {project}.
        slots:
          project: header.x-project-uid
      - text: Get which active experiences take precedence in Personalize project {project}.
        slots:
          project: header.x-project-uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/experiences/priority'].put
  update:
    x-apievangelist-phrasing:
      intent: Reorder experience priority
      effect: write
      questions:
      - How do I make one experience take precedence over another?
      - Can I change the order in which overlapping experiences apply?
      instructions:
      - text: Set the experience priority in project {project} to {priority}.
        slots:
          project: header.x-project-uid
          priority: requestBody.priority
      - text: Reorder experiences in Personalize project {project} as {priority}.
        slots:
          project: header.x-project-uid
          priority: requestBody.priority
      method: generated
      generated: '2026-09-26'