# 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 DeviceUpdateClient Update Management API
  version: 1.0.0
extends: openapi/microsoft-azure-update-management-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: 11
- target: $.paths['/deviceUpdate/{instanceId}/updates'].get
  update:
    x-apievangelist-phrasing:
      intent: List imported device updates
      effect: read
      questions:
      - Which updates have been imported into Device Update for IoT Hub?
      - Can I search my imported device updates with free text?
      instructions:
      - text: List all updates imported into Device Update instance {instance}.
        slots:
          instance: path.instanceId
      - text: Search updates in instance {instance} matching {search}.
        slots:
          instance: path.instanceId
          search: query.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deviceUpdate/{instanceId}/updates:import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import a new device update version
      effect: write
      questions:
      - How do I import a new firmware update version into Device Update for IoT Hub?
      - Is importing an update a long-running operation I need to poll?
      instructions:
      - text: Import a new update version into Device Update instance {instance}.
        slots:
          instance: path.instanceId
      - text: Start an update import on instance {instance} and give me the operation location.
        slots:
          instance: path.instanceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deviceUpdate/{instanceId}/updates/providers/{provider}/names/{name}/versions/{version}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a specific device update version
      effect: read
      questions:
      - What are the details of a specific update version I imported?
      - Can I check one update's metadata by provider, name and version?
      instructions:
      - text: Get update {provider}/{name} version {version} in instance {instance}.
        slots:
          provider: path.provider
          name: path.name
          version: path.version
          instance: path.instanceId
      - text: Show the manifest details of {name} {version} from provider {provider} on {instance}.
        slots:
          name: path.name
          version: path.version
          provider: path.provider
          instance: path.instanceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deviceUpdate/{instanceId}/updates/providers/{provider}/names/{name}/versions/{version}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a device update version
      effect: destructive
      questions:
      - Can I remove an imported update version from Device Update for IoT Hub?
      - Is deleting an update version asynchronous?
      instructions:
      - text: Delete update {provider}/{name} version {version} from instance {instance}.
        slots:
          provider: path.provider
          name: path.name
          version: path.version
          instance: path.instanceId
      - text: Remove version {version} of {name} by {provider} on {instance}.
        slots:
          version: path.version
          name: path.name
          provider: path.provider
          instance: path.instanceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deviceUpdate/{instanceId}/updates/providers'].get
  update:
    x-apievangelist-phrasing:
      intent: List device update providers
      effect: read
      questions:
      - Which update providers have imported updates into my Device Update instance?
      - What vendors appear in my Device Update for IoT Hub catalog?
      instructions:
      - text: List update providers in instance {instance}.
        slots:
          instance: path.instanceId
      - text: Show every update provider that has content on {instance}.
        slots:
          instance: path.instanceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deviceUpdate/{instanceId}/updates/providers/{provider}/names'].get
  update:
    x-apievangelist-phrasing:
      intent: List update names for a provider
      effect: read
      questions:
      - What update names exist for a given update provider?
      - Which products does one provider publish updates for in Device Update?
      instructions:
      - text: List update names for provider {provider} in instance {instance}.
        slots:
          provider: path.provider
          instance: path.instanceId
      - text: Show all update names published by {provider} on {instance}.
        slots:
          provider: path.provider
          instance: path.instanceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deviceUpdate/{instanceId}/updates/providers/{provider}/names/{name}/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List versions of a device update
      effect: read
      questions:
      - Which versions of an update have been imported for a provider and name?
      - Can I filter update versions by their properties?
      instructions:
      - text: List versions of update {provider}/{name} in instance {instance}.
        slots:
          provider: path.provider
          name: path.name
          instance: path.instanceId
      - text: Show versions of {name} from {provider} on {instance} filtered by {filter}.
        slots:
          name: path.name
          provider: path.provider
          instance: path.instanceId
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deviceUpdate/{instanceId}/updates/providers/{provider}/names/{name}/versions/{version}/files'].get
  update:
    x-apievangelist-phrasing:
      intent: List files in a device update version
      effect: read
      questions:
      - What files are included in a specific update version?
      - How do I get the file identifiers for an imported update?
      instructions:
      - text: List file IDs in update {provider}/{name} version {version} on instance {instance}.
        slots:
          provider: path.provider
          name: path.name
          version: path.version
          instance: path.instanceId
      - text: Show the payload files of {name} {version} by {provider} on {instance}.
        slots:
          name: path.name
          version: path.version
          provider: path.provider
          instance: path.instanceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deviceUpdate/{instanceId}/updates/providers/{provider}/names/{name}/versions/{version}/files/{fileId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a file from a device update version
      effect: read
      questions:
      - Can I see the metadata of one file inside an update version?
      - What size and hashes does a specific update file have?
      instructions:
      - text: Get file {file} from update {provider}/{name} version {version} on instance {instance}.
        slots:
          file: path.fileId
          provider: path.provider
          name: path.name
          version: path.version
          instance: path.instanceId
      - text: Show details of update file {file} in {name} {version} ({provider}) on {instance}.
        slots:
          file: path.fileId
          name: path.name
          version: path.version
          provider: path.provider
          instance: path.instanceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deviceUpdate/{instanceId}/updates/operations'].get
  update:
    x-apievangelist-phrasing:
      intent: List update import operations
      effect: read
      questions:
      - Which update imports are running or finished on my Device Update instance?
      - How long are completed import operations kept?
      instructions:
      - text: List import operations on instance {instance}.
        slots:
          instance: path.instanceId
      - text: Show the latest {top} import operations on {instance} matching {filter}.
        slots:
          top: query.top
          instance: path.instanceId
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deviceUpdate/{instanceId}/updates/operations/{operationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an update import operation status
      effect: read
      questions:
      - Did my device update import succeed?
      - How do I check the status of one import operation?
      instructions:
      - text: Get the status of operation {operation} on instance {instance}.
        slots:
          operation: path.operationId
          instance: path.instanceId
      - text: Check whether import operation {operation} on {instance} has finished.
        slots:
          operation: path.operationId
          instance: path.instanceId
      method: generated
      generated: '2026-09-26'