Contentstack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Contentstack Automate Management Variables API

3 actions 3 updates phrasing extends openapi/contentstack-variables-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['/v1/organizations/{organization_uid}/projects/{project_uid}/variables'].get
$.paths['/v1/organizations/{organization_uid}/projects/{project_uid}/variables'].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 Automate Management Variables API
  version: 1.0.0
extends: openapi/contentstack-variables-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['/v1/organizations/{organization_uid}/projects/{project_uid}/variables'].get
  update:
    x-apievangelist-phrasing:
      intent: List automation project variables
      effect: read
      questions:
      - What reusable variables are defined in my automation project?
      - Where can I see the config values my automations share?
      instructions:
      - text: List the variables in project {project} of org {org}.
        slots:
          project: path.project_uid
          org: path.organization_uid
      - text: Show all automation project variables for 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}/variables'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a project variable
      effect: write
      questions:
      - How do I store an API key as a secret variable for my automations?
      - Can a project variable be marked as secret?
      instructions:
      - text: Create variable {name} with key {key} and value {value} in project {project}, org {org}.
        slots:
          name: requestBody.name
          key: requestBody.key
          value: requestBody.value
          project: path.project_uid
          org: path.organization_uid
      - text: Add secret variable {name} ({key}) = {value} marked secret {is_secret} to project {project}, org {org}.
        slots:
          name: requestBody.name
          key: requestBody.key
          value: requestBody.value
          is_secret: requestBody.is_secret
          project: path.project_uid
          org: path.organization_uid
      method: generated
      generated: '2026-09-26'