# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure Service Fabric Client Compose Deployment API
  version: 1.0.0
extends: openapi/microsoft-azure-compose-deployment-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['/ComposeDeployments/$/Create'].put
  update:
    x-apievangelist-phrasing:
      intent: Deploy a Docker Compose app to Service Fabric
      effect: write
      questions:
      - How do I deploy a multi-container app defined in a compose file to Service Fabric?
      - Can I run a Docker Compose application on my Service Fabric cluster?
      instructions:
      - text: Create a compose deployment from description {description}.
        slots:
          description: body.CreateComposeDeploymentDescription
      - text: Deploy this compose file to the Service Fabric cluster using {description}.
        slots:
          description: body.CreateComposeDeploymentDescription
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ComposeDeployments/{deploymentName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the status of one compose deployment
      effect: read
      questions:
      - Has my compose deployment finished provisioning on the cluster?
      - What status does a named compose deployment report?
      instructions:
      - text: Get the status of compose deployment {deployment}.
        slots:
          deployment: path.deploymentName
      - text: Tell me whether compose deployment {deployment} is ready.
        slots:
          deployment: path.deploymentName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ComposeDeployments'].get
  update:
    x-apievangelist-phrasing:
      intent: List compose deployments on the cluster
      effect: read
      questions:
      - Which compose deployments are running on my Service Fabric cluster?
      - Can I page through compose deployments with a continuation token?
      instructions:
      - text: List all compose deployments on the cluster.
      - text: Show up to {max} compose deployments continuing from {token}.
        slots:
          max: query.MaxResults
          token: query.ContinuationToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ComposeDeployments/{deploymentName}/$/GetUpgradeProgress'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a compose deployment's upgrade progress
      effect: read
      questions:
      - How far along is the upgrade of my compose deployment?
      - Why is my compose upgrade stuck — what health details does it report?
      instructions:
      - text: Get the upgrade progress of compose deployment {deployment}.
        slots:
          deployment: path.deploymentName
      - text: Show the latest upgrade state and health for {deployment}.
        slots:
          deployment: path.deploymentName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ComposeDeployments/{deploymentName}/$/Delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a compose deployment
      effect: destructive
      questions:
      - How can I remove a compose deployment from Service Fabric?
      - Can I tear down a Docker Compose app I deployed to the cluster?
      instructions:
      - text: Delete compose deployment {deployment}.
        slots:
          deployment: path.deploymentName
      - text: Remove the {deployment} compose app from the cluster.
        slots:
          deployment: path.deploymentName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ComposeDeployments/{deploymentName}/$/Upgrade'].post
  update:
    x-apievangelist-phrasing:
      intent: Start upgrading a compose deployment
      effect: write
      questions:
      - How do I roll out a new version of a compose deployment?
      - Are my upgrade parameters validated before the compose upgrade starts?
      instructions:
      - text: Upgrade compose deployment {deployment} with {upgrade}.
        slots:
          deployment: path.deploymentName
          upgrade: body.ComposeDeploymentUpgradeDescription
      - text: Start rolling {deployment} forward using upgrade description {upgrade}.
        slots:
          deployment: path.deploymentName
          upgrade: body.ComposeDeploymentUpgradeDescription
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ComposeDeployments/{deploymentName}/$/RollbackUpgrade'].post
  update:
    x-apievangelist-phrasing:
      intent: Roll back a compose deployment upgrade
      effect: write
      questions:
      - Can I roll back a compose upgrade that is going badly?
      - How do I revert a compose deployment to its previous version?
      instructions:
      - text: Roll back the upgrade of compose deployment {deployment}.
        slots:
          deployment: path.deploymentName
      - text: Revert {deployment} to the version before its current upgrade.
        slots:
          deployment: path.deploymentName
      method: generated
      generated: '2026-09-26'