# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Episerver Cloud Deployments API
  version: 1.0.0
extends: openapi/optimizely-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: 6
- target: $.paths['/api/v1.0/projects/{projectId}/packages/location'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an upload location for deployment packages
      effect: read
      questions:
      - Where do I upload a code package before deploying to DXP?
      - How long is the package upload SAS URI valid for?
      instructions:
      - text: Get the package upload location for project {projectId}.
        slots:
          projectId: path.projectId
      - text: Give me a SAS URI to upload deployment packages for project {projectId}.
        slots:
          projectId: path.projectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1.0/projects/{projectId}/deployments/{deploymentId}/reset'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset a deployment in verification
      effect: destructive
      questions:
      - How do I abort a deployment that's sitting in verification and reset the slot?
      - Can I roll back the database when resetting a DXP deployment?
      instructions:
      - text: Reset deployment {deploymentId} in project {projectId}.
        slots:
          projectId: path.projectId
          deploymentId: path.deploymentId
      - text: Reset deployment {deploymentId} in project {projectId} with database rollback {resetWithDbRollback}.
        slots:
          projectId: path.projectId
          deploymentId: path.deploymentId
          resetWithDbRollback: requestBody.resetWithDbRollback
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1.0/projects/{projectId}/deployments/{deploymentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a deployment's status and details
      effect: read
      questions:
      - What stage is a particular deployment in right now?
      - Can I check whether one DXP deployment succeeded?
      instructions:
      - text: Get details of deployment {deploymentId} in project {projectId}.
        slots:
          projectId: path.projectId
          deploymentId: path.deploymentId
      - text: Check the status of deployment {deploymentId} for project {projectId}.
        slots:
          projectId: path.projectId
          deploymentId: path.deploymentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1.0/projects/{projectId}/deployments/{deploymentId}/complete'].post
  update:
    x-apievangelist-phrasing:
      intent: Complete a deployment and swap to production
      effect: write
      questions:
      - How do I finish a verified deployment and swap it into production?
      - When is completing a deployment allowed?
      instructions:
      - text: Complete deployment {deploymentId} in project {projectId}.
        slots:
          projectId: path.projectId
          deploymentId: path.deploymentId
      - text: Swap verified deployment {deploymentId} of project {projectId} into the production slot.
        slots:
          projectId: path.projectId
          deploymentId: path.deploymentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1.0/projects/{projectId}/deployments'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's deployments
      effect: read
      questions:
      - Which deployments have run for my DXP project?
      - Can I see the deployment history of a project?
      instructions:
      - text: List deployments for project {projectId}.
        slots:
          projectId: path.projectId
      - text: Show the deployment history of project {projectId}.
        slots:
          projectId: path.projectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1.0/projects/{projectId}/deployments'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a deployment to an environment
      effect: write
      questions:
      - How do I deploy a code package to a target environment?
      - Can I promote from one environment to another with zero downtime?
      - Is it possible to include the database and blobs in a deployment?
      instructions:
      - text: Deploy packages {packages} to {targetEnvironment} in project {projectId}.
        slots:
          projectId: path.projectId
          packages: requestBody.packages
          targetEnvironment: requestBody.targetEnvironment
      - text: Promote {sourceEnvironment} to {targetEnvironment} for project {projectId}.
        slots:
          projectId: path.projectId
          sourceEnvironment: requestBody.sourceEnvironment
          targetEnvironment: requestBody.targetEnvironment
      - text: Start a deployment in project {projectId} to {targetEnvironment} using zero downtime mode {zeroDowntimeMode}.
        slots:
          projectId: path.projectId
          targetEnvironment: requestBody.targetEnvironment
          zeroDowntimeMode: requestBody.zeroDowntimeMode
      method: generated
      generated: '2026-09-26'