Contentstack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Contentstack Entries API

8 actions 8 updates phrasing extends openapi/contentstack-entries-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['/content_types/{content_type_uid}/entries'].get
$.paths['/content_types/{content_type_uid}/entries'].post
$.paths['/content_types/{content_type_uid}/entries/{entry_uid}'].get
$.paths['/content_types/{content_type_uid}/entries/{entry_uid}'].put
$.paths['/content_types/{content_type_uid}/entries/{entry_uid}'].delete
$.paths['/content_types/{content_type_uid}/entries/{entry_uid}/publish'].post
$.paths['/content_types/{content_type_uid}/entries/{entry_uid}/unpublish'].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 Contentstack Entries API
  version: 1.0.0
extends: openapi/contentstack-entries-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['/content_types/{content_type_uid}/entries'].get
  update:
    x-apievangelist-phrasing:
      intent: List published entries of a content type
      effect: read
      questions:
      - How do I fetch all published entries for a content type in Contentstack?
      - Can I filter, sort and paginate entries with skip and limit?
      - Is there a way to include referenced entries when listing entries?
      instructions:
      - text: List published entries of content type {content_type}.
        slots:
          content_type: path.content_type_uid
      - text: Get {limit} entries of {content_type} in locale {locale}, skipping {skip}.
        slots:
          limit: query.limit
          content_type: path.content_type_uid
          locale: query.locale
          skip: query.skip
      - text: Find {content_type} entries matching query {query} with the total count.
        slots:
          content_type: path.content_type_uid
          query: query.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/content_types/{content_type_uid}/entries'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a draft entry
      effect: write
      questions:
      - How do I add a new entry to a content type?
      - Are newly created entries published automatically or left as drafts?
      instructions:
      - text: Create a new {content_type} entry with data {entry}.
        slots:
          content_type: path.content_type_uid
          entry: requestBody.entry
      - text: Add a draft {content_type} entry in locale {locale} using {entry}.
        slots:
          content_type: path.content_type_uid
          locale: query.locale
          entry: requestBody.entry
      method: generated
      generated: '2026-09-26'
- target: $.paths['/content_types/{content_type_uid}/entries/{entry_uid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one published entry
      effect: read
      questions:
      - How do I retrieve a single published entry by its UID?
      - Can I fetch a specific version of an entry?
      instructions:
      - text: Get entry {entry} of content type {content_type}.
        slots:
          entry: path.entry_uid
          content_type: path.content_type_uid
      - text: Fetch version {version} of entry {entry} in {content_type}, locale {locale}.
        slots:
          version: query.version
          entry: path.entry_uid
          content_type: path.content_type_uid
          locale: query.locale
      method: generated
      generated: '2026-09-26'
- target: $.paths['/content_types/{content_type_uid}/entries/{entry_uid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update fields on an existing entry
      effect: write
      questions:
      - How do I change field values on an entry that already exists?
      - Do fields I leave out of an entry update keep their current values?
      instructions:
      - text: Update entry {entry} of {content_type} with {data}.
        slots:
          entry: path.entry_uid
          content_type: path.content_type_uid
          data: requestBody.entry
      - text: Edit the {locale} version of entry {entry} in {content_type} to {data}.
        slots:
          locale: query.locale
          entry: path.entry_uid
          content_type: path.content_type_uid
          data: requestBody.entry
      method: generated
      generated: '2026-09-26'
- target: $.paths['/content_types/{content_type_uid}/entries/{entry_uid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an entry
      effect: destructive
      questions:
      - Do I need to unpublish an entry before deleting it?
      - Can a deleted Contentstack entry be recovered?
      instructions:
      - text: Delete entry {entry} from content type {content_type}.
        slots:
          entry: path.entry_uid
          content_type: path.content_type_uid
      - text: Permanently remove {content_type} entry {entry} from the stack.
        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}/publish'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish an entry to environments
      effect: write
      questions:
      - How do I make an entry live on my production environment?
      - Can I publish an entry to several environments and locales at once?
      instructions:
      - text: Publish entry {entry} of {content_type}.
        slots:
          entry: path.entry_uid
          content_type: path.content_type_uid
      - text: Publish {content_type} entry {entry} to the environments and locales in {targets}.
        slots:
          content_type: path.content_type_uid
          entry: path.entry_uid
          targets: requestBody.entry
      method: generated
      generated: '2026-09-26'
- target: $.paths['/content_types/{content_type_uid}/entries/{entry_uid}/unpublish'].post
  update:
    x-apievangelist-phrasing:
      intent: Unpublish an entry from environments
      effect: write
      questions:
      - How do I take an entry offline so the delivery API stops returning it?
      - Can I unpublish an entry from staging only and keep it live elsewhere?
      instructions:
      - text: Unpublish entry {entry} of {content_type}.
        slots:
          entry: path.entry_uid
          content_type: path.content_type_uid
      - text: Pull {content_type} entry {entry} from the environments listed in {targets}.
        slots:
          content_type: path.content_type_uid
          entry: path.entry_uid
          targets: requestBody.entry
      method: generated
      generated: '2026-09-26'