# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Extensibility Package Deployment API
  version: 1.0.0
extends: openapi/conga-package-deployment-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 8
- target: $.paths['/api/extensibility/v2/deployment/history'].get
  update:
    x-apievangelist-phrasing:
      intent: List package deployment history
      effect: read
      questions:
      - What custom code packages have been deployed?
      - Can I see only snapshot deployments in the history?
      instructions:
      - text: Show the package deployment history.
      - text: List deployment history with snapshots {snap}.
        slots:
          snap: query.isSnapshot
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/extensibility/v2/deployment/package/deploy'].post
  update:
    x-apievangelist-phrasing:
      intent: Deploy a source package
      effect: write
      questions:
      - How do I deploy a custom code package?
      - Can I add a description to a package deployment?
      instructions:
      - text: Deploy package file {file}.
        slots:
          file: requestBody.File
      - text: Deploy {file} with description {desc}.
        slots:
          file: requestBody.File
          desc: query.Description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/extensibility/v2/deployment/package/promote'].post
  update:
    x-apievangelist-phrasing:
      intent: Promote a package to another environment
      effect: write
      questions:
      - How do I promote a package to production?
      - What details does promoting to a target environment need?
      instructions:
      - text: Promote the package to the environment at {uri}.
        slots:
          uri: requestBody.ReleaseUri
      - text: Promote to target login {login} with client {client}.
        slots:
          login: requestBody.LoginUri
          client: requestBody.ClientId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/extensibility/v2/deployment/package/{name}/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a package's deployment history
      effect: read
      questions:
      - Where has a particular package been deployed?
      - What resources did a package deploy?
      instructions:
      - text: Show deployment history for package {name}.
        slots:
          name: path.name
      - text: List resources deployed by package {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/extensibility/v2/deployment/package/{name}/info'].get
  update:
    x-apievangelist-phrasing:
      intent: Get package information
      effect: read
      questions:
      - What version and details does a package have?
      - Can I inspect one package's info?
      instructions:
      - text: Get package info for {name}.
        slots:
          name: path.name
      - text: Show the details of package {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/extensibility/v2/deployment/package/{name}/rollback'].post
  update:
    x-apievangelist-phrasing:
      intent: Roll back a package deployment
      effect: destructive
      questions:
      - Can I undo a custom code deployment?
      - How do I revert a package to its previous state?
      instructions:
      - text: Roll back package {name}.
        slots:
          name: path.name
      - text: Revert the deployment of {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/extensibility/v2/deployment/{deploymentId}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get deployment logs
      effect: read
      questions:
      - Why did a package deployment fail?
      - Can I read the logs of one deployment?
      instructions:
      - text: Get logs for deployment {id}.
        slots:
          id: path.deploymentId
      - text: Show deployment {id} log output.
        slots:
          id: path.deploymentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/extensibility/v2/deployment/{deploymentId}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Track deployment status
      effect: read
      questions:
      - Is my package deployment finished?
      - How do I track progress of a deployment?
      instructions:
      - text: Check status of deployment {id}.
        slots:
          id: path.deploymentId
      - text: Track deployment {id}.
        slots:
          id: path.deploymentId
      method: generated
      generated: '2026-10-01'