Contentstack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Contentstack Content Management Stacks API

6 actions 6 updates phrasing extends openapi/contentstack-stacks-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 6

$.info
$.paths['/stacks'].get
$.paths['/stacks'].post
$.paths['/stacks/{api_key}'].get
$.paths['/stacks/{api_key}'].put
$.paths['/stacks/{api_key}'].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 Content Management Stacks API
  version: 1.0.0
extends: openapi/contentstack-stacks-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/stacks'].get
  update:
    x-apievangelist-phrasing:
      intent: List stacks I can access
      effect: read
      questions:
      - Which Contentstack stacks do I have access to?
      - Can I see all my stacks across organizations?
      instructions:
      - text: List all the stacks I can access.
      - text: Show every stack available to my user.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/stacks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a stack
      effect: write
      questions:
      - How do I create a new stack in my organization?
      - What is a stack and how do I set one up?
      instructions:
      - text: Create a stack {stack} in organization {org}.
        slots:
          stack: requestBody.stack
          org: header.organization_uid
      - text: Set up a new content stack in org {org} with settings {stack}.
        slots:
          org: header.organization_uid
          stack: requestBody.stack
      method: generated
      generated: '2026-09-26'
- target: $.paths['/stacks/{api_key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a stack's settings
      effect: read
      questions:
      - How do I see a stack's plan and region?
      - Can I look up a stack's configuration by its API key?
      instructions:
      - text: Show stack {api_key}.
        slots:
          api_key: header.api_key
      - text: Get the plan, region and settings of stack {api_key}.
        slots:
          api_key: path.api_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stacks/{api_key}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a stack's settings
      effect: write
      questions:
      - How do I rename a stack or change its description?
      - Can I change a stack's master locale settings?
      instructions:
      - text: Update stack {api_key} with {stack}.
        slots:
          api_key: header.api_key
          stack: requestBody.stack
      - text: Rename stack {api_key} using settings {stack}.
        slots:
          api_key: path.api_key
          stack: requestBody.stack
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stacks/{api_key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a stack
      effect: destructive
      questions:
      - What gets deleted when I remove a whole stack?
      - Is deleting a Contentstack stack irreversible?
      instructions:
      - text: Delete stack {api_key}.
        slots:
          api_key: header.api_key
      - text: Permanently delete stack {api_key} with all its content types, entries and assets.
        slots:
          api_key: path.api_key
      method: generated
      generated: '2026-10-01'