Contentstack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Contentstack Automate Management Automations API

5 actions 5 updates phrasing extends openapi/contentstack-automations-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 5

$.info

$.paths['/v1/organizations/{organization_uid}/projects/{project_uid}/automations'].get

$.paths['/v1/organizations/{organization_uid}/projects/{project_uid}/automations/{automation_uid}'].get

$.paths['/v1/organizations/{organization_uid}/projects/{project_uid}/automations/{automation_uid}/activate'].put

$.paths['/v1/organizations/{organization_uid}/projects/{project_uid}/automations/{automation_uid}/deactivate'].put

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 Automate Management Automations API
  version: 1.0.0
extends: openapi/contentstack-automations-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: 4
- target: $.paths['/v1/organizations/{organization_uid}/projects/{project_uid}/automations'].get
  update:
    x-apievangelist-phrasing:
      intent: List automations in a project
      effect: read
      questions:
      - Which automations are defined in my Automation Hub project?
      - How can I tell which automations are currently active?
      instructions:
      - text: List the automations in project {project} of org {org}.
        slots:
          project: path.project_uid
          org: path.organization_uid
      - text: Show triggers and activation status of all automations in project {project}, org {org}.
        slots:
          project: path.project_uid
          org: path.organization_uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organization_uid}/projects/{project_uid}/automations/{automation_uid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an automation's configuration
      effect: read
      questions:
      - How do I view the trigger and steps of one automation?
      - What error handling does a specific automation have?
      instructions:
      - text: Show automation {automation} in project {project} of org {org}.
        slots:
          automation: path.automation_uid
          project: path.project_uid
          org: path.organization_uid
      - text: Get the trigger and action steps of automation {automation}, project {project}, org {org}.
        slots:
          automation: path.automation_uid
          project: path.project_uid
          org: path.organization_uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organization_uid}/projects/{project_uid}/automations/{automation_uid}/activate'].put
  update:
    x-apievangelist-phrasing:
      intent: Activate an automation
      effect: write
      questions:
      - How do I turn on an automation so it runs on its trigger?
      - Can an automation be enabled if it isn't fully configured?
      instructions:
      - text: Activate automation {automation} in project {project} of org {org}.
        slots:
          automation: path.automation_uid
          project: path.project_uid
          org: path.organization_uid
      - text: Turn on automation {automation} so it runs on its trigger (project {project}, org {org}).
        slots:
          automation: path.automation_uid
          project: path.project_uid
          org: path.organization_uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organization_uid}/projects/{project_uid}/automations/{automation_uid}/deactivate'].put
  update:
    x-apievangelist-phrasing:
      intent: Deactivate an automation
      effect: write
      questions:
      - How do I pause an automation without deleting it?
      - Do in-progress runs finish when I disable an automation?
      instructions:
      - text: Deactivate automation {automation} in project {project} of org {org}.
        slots:
          automation: path.automation_uid
          project: path.project_uid
          org: path.organization_uid
      - text: Turn off automation {automation} so its trigger stops firing (project {project}, org {org}).
        slots:
          automation: path.automation_uid
          project: path.project_uid
          org: path.organization_uid
      method: generated
      generated: '2026-09-26'