Contentstack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Contentstack Content Delivery Entry Variants API

3 actions 3 updates phrasing extends openapi/contentstack-entry-variants-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 3

$.info

$.paths['/content_types/{content_type_uid}/entries/{entry_uid}/variants'].get

$.paths['/content_types/{content_type_uid}/entries/{entry_uid}/variants/{variant_uid}'].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 Contentstack Content Delivery Entry Variants API
  version: 1.0.0
extends: openapi/contentstack-entry-variants-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: 2
- target: $.paths['/content_types/{content_type_uid}/entries/{entry_uid}/variants'].get
  update:
    x-apievangelist-phrasing:
      intent: List personalization variants of an entry
      effect: read
      questions:
      - What personalized variants exist for one of my entries?
      - How do I see the customized field values of every variant of an entry?
      instructions:
      - text: List the variants of entry {entry} in content type {content_type}.
        slots:
          entry: path.entry_uid
          content_type: path.content_type_uid
      - text: Show all personalization variants for {content_type} entry {entry}.
        slots:
          content_type: path.content_type_uid
          entry: path.entry_uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/content_types/{content_type_uid}/entries/{entry_uid}/variants/{variant_uid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one variant of an entry
      effect: read
      questions:
      - How do I fetch a specific variant of an entry by variant UID?
      - What field values does a particular entry variant override?
      instructions:
      - text: Get variant {variant} of entry {entry} in {content_type}.
        slots:
          variant: path.variant_uid
          entry: path.entry_uid
          content_type: path.content_type_uid
      - text: Show the customized fields of variant {variant} for {content_type} entry {entry}.
        slots:
          variant: path.variant_uid
          content_type: path.content_type_uid
          entry: path.entry_uid
      method: generated
      generated: '2026-09-26'