# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for ml Aliases API
  version: 1.0.0
extends: openapi/qliksense-aliases-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['/api/v1/ml/deployments/{deploymentId}/aliases'].get
  update:
    x-apievangelist-phrasing:
      intent: List aliases on a deployment
      effect: read
      questions:
      - What aliases exist for my ML deployment?
      - Can I filter the aliases on a deployment?
      instructions:
      - text: List aliases for deployment {deploymentId}.
        slots:
          deploymentId: path.deploymentId
      - text: Show aliases on deployment {deploymentId} matching {filter}.
        slots:
          deploymentId: path.deploymentId
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/ml/deployments/{deploymentId}/aliases'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an alias for a deployment
      effect: write
      questions:
      - How do I create an alias pointing to a model in a deployment?
      - Can I give a deployment a named alias?
      instructions:
      - text: Create an alias on deployment {deploymentId} with {data}.
        slots:
          deploymentId: path.deploymentId
          data: requestBody.data
      - text: Add a new alias to deployment {deploymentId}.
        slots:
          deploymentId: path.deploymentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/ml/deployments/{deploymentId}/aliases/{aliasId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a deployment alias
      effect: read
      questions:
      - Which model does a particular alias point to?
      - Where can I see one alias's details?
      instructions:
      - text: Get alias {aliasId} on deployment {deploymentId}.
        slots:
          aliasId: path.aliasId
          deploymentId: path.deploymentId
      - text: Show details of alias {aliasId} in deployment {deploymentId}.
        slots:
          aliasId: path.aliasId
          deploymentId: path.deploymentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/ml/deployments/{deploymentId}/aliases/{aliasId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a deployment alias
      effect: destructive
      questions:
      - How do I remove an alias from a deployment?
      - Can I delete an alias without deleting the deployment?
      instructions:
      - text: Delete alias {aliasId} from deployment {deploymentId}.
        slots:
          aliasId: path.aliasId
          deploymentId: path.deploymentId
      - text: Remove the alias {aliasId} on {deploymentId}.
        slots:
          aliasId: path.aliasId
          deploymentId: path.deploymentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/ml/deployments/{deploymentId}/aliases/{aliasId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a deployment alias
      effect: write
      questions:
      - Can I repoint an alias to a different model?
      - How do I edit an existing alias?
      instructions:
      - text: Update alias {aliasId} on deployment {deploymentId}.
        slots:
          aliasId: path.aliasId
          deploymentId: path.deploymentId
      - text: Change which model alias {aliasId} in {deploymentId} uses.
        slots:
          aliasId: path.aliasId
          deploymentId: path.deploymentId
      method: generated
      generated: '2026-09-26'