Zoom Phone · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Phone Firmware Update Rules API

7 actions 7 updates phrasing extends openapi/zoom-phone-firmware-update-rules-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Zoom Phone's API. It is a proposal applied on top of the contract, not a document Zoom Phone publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info

$.paths['/phone/firmware_update_rules'].get

$.paths['/phone/firmware_update_rules'].post

$.paths['/phone/firmware_update_rules/{ruleId}'].get

$.paths['/phone/firmware_update_rules/{ruleId}'].delete

$.paths['/phone/firmware_update_rules/{ruleId}'].patch

$.paths['/phone/firmwares'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Phone Firmware Update Rules API
  version: 1.0.0
extends: openapi/zoom-phone-firmware-update-rules-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: 6
- target: $.paths['/phone/firmware_update_rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List firmware update rules
      effect: read
      questions:
      - What firmware update rules are set up for our desk phones?
      - Can I see firmware rules for just one site?
      instructions:
      - text: List firmware update rules.
      - text: List firmware update rules for site {site_id}.
        slots:
          site_id: query.site_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/firmware_update_rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a firmware update rule
      effect: write
      questions:
      - How do I pin a desk phone model to a specific firmware version?
      - Can I choose whether phones restart right away after a firmware rule applies?
      instructions:
      - text: Add a firmware rule for {device_type} {device_model} to version {version}.
        slots:
          device_type: requestBody.device_type
          device_model: requestBody.device_model
          version: requestBody.version
      - text: Create a firmware rule at site {site_id} moving {device_type} {device_model} to {version} with restart {restart_type}.
        slots:
          site_id: requestBody.site_id
          device_type: requestBody.device_type
          device_model: requestBody.device_model
          version: requestBody.version
          restart_type: requestBody.restart_type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/firmware_update_rules/{ruleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a firmware update rule
      effect: read
      questions:
      - Which firmware version and phone model does a given update rule target?
      - Can I look up one firmware rule by ID?
      instructions:
      - text: Show firmware update rule {ruleId}.
        slots:
          ruleId: path.ruleId
      - text: Get the target version of firmware rule {ruleId}.
        slots:
          ruleId: path.ruleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/firmware_update_rules/{ruleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a firmware update rule
      effect: destructive
      questions:
      - How do I delete a firmware update rule?
      - Do phones restart when I remove their firmware rule?
      instructions:
      - text: Delete firmware update rule {ruleId}.
        slots:
          ruleId: path.ruleId
      - text: Remove firmware rule {ruleId} with restart option {restart_type}.
        slots:
          ruleId: path.ruleId
          restart_type: query.restart_type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/firmware_update_rules/{ruleId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a firmware update rule
      effect: write
      questions:
      - Can I change the firmware version an existing rule pushes?
      - How do I edit an update rule's target model?
      instructions:
      - text: Update firmware rule {ruleId} to version {version} for {device_type} {device_model}.
        slots:
          ruleId: path.ruleId
          version: requestBody.version
          device_type: requestBody.device_type
          device_model: requestBody.device_model
      - text: Change rule {ruleId} so {device_type} {device_model} phones get firmware {version}.
        slots:
          ruleId: path.ruleId
          version: requestBody.version
          device_type: requestBody.device_type
          device_model: requestBody.device_model
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/firmwares'].get
  update:
    x-apievangelist-phrasing:
      intent: List available desk phone firmware
      effect: read
      questions:
      - Which firmware versions are available to update our desk phones to?
      - Can I see updatable firmware for a particular site?
      instructions:
      - text: List updatable desk phone firmwares.
      - text: Show firmware versions available for site {site_id}.
        slots:
          site_id: query.site_id
      method: generated
      generated: '2026-10-01'