Contentstack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Contentstack Launch Deployments API

6 actions 6 updates phrasing extends openapi/contentstack-deployments-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['/projects/{project_uid}/environments/{env_uid}/deployments'].get
$.paths['/projects/{project_uid}/environments/{env_uid}/deployments'].post
$.paths['/projects/{project_uid}/environments/{env_uid}/deployments/{deploy_uid}'].get
$.paths['/projects/{project_uid}/environments/{env_uid}/deployments/{deploy_uid}/logs'].get
$.paths['/projects/{project_uid}/environments/{env_uid}/deployments/{deploy_uid}/server-logs'].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 Launch Deployments API
  version: 1.0.0
extends: openapi/contentstack-deployments-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: 5
- target: $.paths['/projects/{project_uid}/environments/{env_uid}/deployments'].get
  update:
    x-apievangelist-phrasing:
      intent: List deployments for a Launch environment
      effect: read
      questions:
      - How do I see the deployment history of a Launch environment?
      - Which of my recent Launch deployments failed?
      instructions:
      - text: List deployments for environment {env} in project {project}.
        slots:
          env: path.env_uid
          project: path.project_uid
      - text: Show the deployment history of 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}/deployments'].post
  update:
    x-apievangelist-phrasing:
      intent: Deploy to a Launch environment
      effect: write
      questions:
      - How do I trigger a new deployment on Launch?
      - Can I deploy a specific git branch to a Launch environment?
      - Do I need to upload a build artifact before deploying?
      instructions:
      - text: Deploy upload {upload} to environment {env} of project {project}.
        slots:
          upload: requestBody.upload_uid
          env: path.env_uid
          project: path.project_uid
      - text: Deploy branch {branch} to Launch environment {env} in project {project}.
        slots:
          branch: requestBody.branch
          env: path.env_uid
          project: path.project_uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_uid}/environments/{env_uid}/deployments/{deploy_uid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a deployment's status
      effect: read
      questions:
      - Did my Launch deployment finish successfully?
      - How do I check the build configuration of one specific deployment?
      instructions:
      - text: Show deployment {deploy} in environment {env} of project {project}.
        slots:
          deploy: path.deploy_uid
          env: path.env_uid
          project: path.project_uid
      - text: Check the status of Launch deployment {deploy} for env {env}, project {project}.
        slots:
          deploy: path.deploy_uid
          env: path.env_uid
          project: path.project_uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_uid}/environments/{env_uid}/deployments/{deploy_uid}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get build logs for a deployment
      effect: read
      questions:
      - Where can I read the build output of a failed Launch deployment?
      - How do I monitor build progress for a deployment?
      instructions:
      - text: Get the build logs for deployment {deploy} in env {env} of project {project}.
        slots:
          deploy: path.deploy_uid
          env: path.env_uid
          project: path.project_uid
      - text: Show why Launch deployment {deploy} (env {env}, project {project}) failed to build.
        slots:
          deploy: path.deploy_uid
          env: path.env_uid
          project: path.project_uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_uid}/environments/{env_uid}/deployments/{deploy_uid}/server-logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get runtime server logs for a deployment
      effect: read
      questions:
      - How do I debug server-side rendering errors on my Launch site?
      - Can I see runtime server logs of a deployed Launch app?
      instructions:
      - text: Get the server runtime logs for deployment {deploy} in env {env} of project {project}.
        slots:
          deploy: path.deploy_uid
          env: path.env_uid
          project: path.project_uid
      - text: Show SSR runtime errors for Launch deployment {deploy}, env {env}, project {project}.
        slots:
          deploy: path.deploy_uid
          env: path.env_uid
          project: path.project_uid
      method: generated
      generated: '2026-09-26'