# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Sigma Computing Deployment Policies API
  version: 1.0.0
extends: openapi/sigma-computing-deploymentpolicies-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: 12
- target: $.paths['/v2/deploymentPolicies'].get
  update:
    x-apievangelist-phrasing:
      intent: List deployment policies
      effect: read
      questions:
      - What deployment policies are set up in my Sigma organization?
      - How do I page through deployment policies?
      instructions:
      - text: List all deployment policies.
      - text: List deployment policies, {pageSize} per page.
        slots:
          pageSize: query.pageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/deploymentPolicies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a deployment policy
      effect: write
      questions:
      - How do I define which documents get deployed to tenant organizations?
      - Can a deployment policy swap sources as it deploys?
      instructions:
      - text: Create a deployment policy named {name}.
        slots:
          name: requestBody.name
      - text: Create deployment policy {name} for version tag {versionTagId} with source swap policies {sourceSwapPolicies}.
        slots:
          name: requestBody.name
          versionTagId: requestBody.versionTagId
          sourceSwapPolicies: requestBody.sourceSwapPolicies
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/deploymentPolicies/{deploymentPolicyId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a deployment policy
      effect: read
      questions:
      - How do I see the settings of one deployment policy?
      - What version tag does a deployment policy use?
      instructions:
      - text: Get deployment policy {deploymentPolicyId}.
        slots:
          deploymentPolicyId: path.deploymentPolicyId
      - text: Show the configuration of deployment policy {deploymentPolicyId}.
        slots:
          deploymentPolicyId: path.deploymentPolicyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/deploymentPolicies/{deploymentPolicyId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Archive a deployment policy
      effect: destructive
      questions:
      - How do I retire a deployment policy I no longer use?
      - Can deployment policies be archived through the API?
      instructions:
      - text: Archive deployment policy {deploymentPolicyId}.
        slots:
          deploymentPolicyId: path.deploymentPolicyId
      - text: Retire the {deploymentPolicyId} deployment policy.
        slots:
          deploymentPolicyId: path.deploymentPolicyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/deploymentPolicies/{deploymentPolicyId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a deployment policy
      effect: write
      questions:
      - Can I rename a deployment policy or change its name in tenants?
      - Does updating a deployment policy only change the fields I send?
      instructions:
      - text: Rename deployment policy {deploymentPolicyId} to {name}.
        slots:
          deploymentPolicyId: path.deploymentPolicyId
          name: requestBody.name
      - text: Set the tenant-facing name of deployment policy {deploymentPolicyId} to {nameInTenant}.
        slots:
          deploymentPolicyId: path.deploymentPolicyId
          nameInTenant: requestBody.nameInTenant
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/deploymentPolicies/{deploymentPolicyId}/files'].get
  update:
    x-apievangelist-phrasing:
      intent: List documents in a deployment policy
      effect: read
      questions:
      - Which workbooks and data models are included in a deployment policy?
      - Why would a document in a deployment policy show a null inode?
      instructions:
      - text: List the documents in deployment policy {deploymentPolicyId}.
        slots:
          deploymentPolicyId: path.deploymentPolicyId
      - text: Show which workbooks deployment policy {deploymentPolicyId} deploys.
        slots:
          deploymentPolicyId: path.deploymentPolicyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/deploymentPolicies/{deploymentPolicyId}/files'].post
  update:
    x-apievangelist-phrasing:
      intent: Add documents to a deployment policy
      effect: write
      questions:
      - How do I include more workbooks in a deployment policy?
      - Can I add several documents to a deployment policy in one call?
      instructions:
      - text: Add documents {inodeIds} to deployment policy {deploymentPolicyId}.
        slots:
          inodeIds: requestBody.inodeIds
          deploymentPolicyId: path.deploymentPolicyId
      - text: Include workbooks {inodeIds} in the {deploymentPolicyId} deployment.
        slots:
          inodeIds: requestBody.inodeIds
          deploymentPolicyId: path.deploymentPolicyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/deploymentPolicies/{deploymentPolicyId}/files/{inodeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a document from a deployment policy
      effect: destructive
      questions:
      - How do I stop deploying a particular workbook to tenants?
      - Can I take one document out of a deployment policy?
      instructions:
      - text: Remove document {inodeId} from deployment policy {deploymentPolicyId}.
        slots:
          inodeId: path.inodeId
          deploymentPolicyId: path.deploymentPolicyId
      - text: Stop deploying workbook {inodeId} via policy {deploymentPolicyId}.
        slots:
          inodeId: path.inodeId
          deploymentPolicyId: path.deploymentPolicyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/deploymentPolicies/{deploymentPolicyId}/tenants'].get
  update:
    x-apievangelist-phrasing:
      intent: List tenants on a deployment policy
      effect: read
      questions:
      - Which tenant organizations receive a given deployment policy?
      - How do I audit where a deployment policy's documents go?
      instructions:
      - text: List the tenants on deployment policy {deploymentPolicyId}.
        slots:
          deploymentPolicyId: path.deploymentPolicyId
      - text: Show every tenant receiving deployment {deploymentPolicyId}.
        slots:
          deploymentPolicyId: path.deploymentPolicyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/deploymentPolicies/{deploymentPolicyId}/tenants'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a tenant to a deployment policy
      effect: write
      questions:
      - How do I start deploying documents to a new tenant organization?
      - Can I attach a tenant to an existing deployment policy?
      instructions:
      - text: Add tenant {tenantOrganizationId} to deployment policy {deploymentPolicyId}.
        slots:
          tenantOrganizationId: requestBody.tenantOrganizationId
          deploymentPolicyId: path.deploymentPolicyId
      - text: Deploy policy {deploymentPolicyId} to tenant {tenantOrganizationId} too.
        slots:
          deploymentPolicyId: path.deploymentPolicyId
          tenantOrganizationId: requestBody.tenantOrganizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/deploymentPolicies/{deploymentPolicyId}/tenants/{tenantOrganizationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a tenant from a deployment policy
      effect: destructive
      questions:
      - How do I stop a tenant from receiving a deployment policy?
      - Can I detach one tenant organization from a deployment?
      instructions:
      - text: Remove tenant {tenantOrganizationId} from deployment policy {deploymentPolicyId}.
        slots:
          tenantOrganizationId: path.tenantOrganizationId
          deploymentPolicyId: path.deploymentPolicyId
      - text: Detach tenant {tenantOrganizationId} from the {deploymentPolicyId} deployment.
        slots:
          tenantOrganizationId: path.tenantOrganizationId
          deploymentPolicyId: path.deploymentPolicyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/deploymentPolicies/tenants'].get
  update:
    x-apievangelist-phrasing:
      intent: List tenants I can deploy to
      effect: read
      questions:
      - Which tenant organizations is my organization allowed to deploy to?
      - Can I search the tenants available for deployment?
      instructions:
      - text: List the tenant organizations I can deploy to.
      - text: Search deployable tenants for {search}.
        slots:
          search: query.search
      method: generated
      generated: '2026-09-26'