# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Contentstack Environments API
  version: 1.0.0
extends: openapi/contentstack-environments-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['/environments'].get
  update:
    x-apievangelist-phrasing:
      intent: List a stack's publishing environments
      effect: read
      questions:
      - Which publishing environments like production and staging are set up in my stack?
      - How do I see the environments configured on a Contentstack stack?
      instructions:
      - text: List the publishing environments in stack {api_key}.
        slots:
          api_key: header.api_key
      - text: Show the stack-level environments for stack {api_key}.
        slots:
          api_key: header.api_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_uid}/environments'].get
  update:
    x-apievangelist-phrasing:
      intent: List a Launch project's environments
      effect: read
      questions:
      - What environments and domains does my Launch project have?
      - How can I check the deployment status of each environment in a Launch project?
      instructions:
      - text: List the environments of Launch project {project}.
        slots:
          project: path.project_uid
      - text: Show domains and deployment status for every environment in Launch project {project}.
        slots:
          project: path.project_uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_uid}/environments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Launch environment
      effect: write
      questions:
      - How do I add a new hosting environment to a Launch project?
      - Can I give a new Launch environment its own domain?
      instructions:
      - text: Create environment {name} in Launch project {project}.
        slots:
          name: requestBody.name
          project: path.project_uid
      - text: Add Launch environment {name} on domain {domain} to project {project}.
        slots:
          name: requestBody.name
          domain: requestBody.domain
          project: path.project_uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_uid}/environments/{env_uid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Launch environment's details
      effect: read
      questions:
      - What's the latest deployment status of one Launch environment?
      - How do I view the domain and framework settings of a Launch environment?
      instructions:
      - text: Show environment {env} in Launch project {project}.
        slots:
          env: path.env_uid
          project: path.project_uid
      - text: Get domain and latest deployment info for Launch environment {env} of project {project}.
        slots:
          env: path.env_uid
          project: path.project_uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_uid}/environments/{env_uid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Launch environment
      effect: write
      questions:
      - Can I change the domain of an existing Launch environment?
      - How do I rename a hosting environment in Launch?
      instructions:
      - text: Rename Launch environment {env} in project {project} to {name}.
        slots:
          env: path.env_uid
          project: path.project_uid
          name: requestBody.name
      - text: Point Launch environment {env} of project {project}, named {name}, at domain {domain}.
        slots:
          env: path.env_uid
          project: path.project_uid
          name: requestBody.name
          domain: requestBody.domain
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_uid}/environments/{env_uid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Launch environment
      effect: destructive
      questions:
      - Does deleting a Launch environment remove its deployment history too?
      - How do I get rid of a Launch environment I don't use?
      instructions:
      - text: Delete environment {env} from Launch project {project}.
        slots:
          env: path.env_uid
          project: path.project_uid
      - text: Permanently remove Launch environment {env} in project {project}.
        slots:
          env: path.env_uid
          project: path.project_uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_uid}/environments/{env_uid}/revalidate-cache'].post
  update:
    x-apievangelist-phrasing:
      intent: Revalidate the CDN cache for an environment
      effect: write
      questions:
      - How do I force the CDN to serve fresh content for my Launch site?
      - Is there a quota on how often I can revalidate the CDN cache?
      - Can I purge only specific paths instead of the whole site cache?
      instructions:
      - text: Revalidate the CDN cache for environment {env} of project {project}.
        slots:
          env: path.env_uid
          project: path.project_uid
      - text: Refresh cached paths {paths} on Launch environment {env} in project {project}.
        slots:
          paths: requestBody.paths
          env: path.env_uid
          project: path.project_uid
      method: generated
      generated: '2026-09-26'