Contentstack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Contentstack Content Delivery Synchronization API

2 actions 2 updates phrasing extends openapi/contentstack-synchronization-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 2

$.info
$.paths['/stacks/sync'].get

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 Content Delivery Synchronization API
  version: 1.0.0
extends: openapi/contentstack-synchronization-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: 1
- target: $.paths['/stacks/sync'].get
  update:
    x-apievangelist-phrasing:
      intent: Sync published content changes
      effect: read
      questions:
      - How do I download all published entries and assets for an offline copy?
      - Can I fetch only what changed since my last sync?
      - Is there a way to sync just deleted entries or one content type?
      instructions:
      - text: Start an initial sync of stack {api_key} with init {init}.
        slots:
          api_key: header.api_key
          init: query.init
      - text: Fetch changes since sync token {sync_token}.
        slots:
          sync_token: query.sync_token
      - text: Sync {type} items for content type {content_type} in locale {locale}.
        slots:
          type: query.type
          content_type: query.content_type_uid
          locale: query.locale
      method: generated
      generated: '2026-09-26'