Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks Vms API

13 actions 13 updates phrasing extends openapi/palo-alto-networks-vms-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Palo Alto Networks's API. It is a proposal applied on top of the contract, not a document Palo Alto Networks publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 13

$.info
$.paths['/api/v34.03/vms'].get
$.paths['/api/v34.03/vms/download'].get
$.paths['/api/v34.03/vms/labels'].get
$.paths['/api/v34.03/vms/names'].get
$.paths['/api/v34.03/vms/scan'].post
$.paths['/api/v34.03/vms/stop'].post
$.paths['/api/v34.04/vms'].get
$.paths['/api/v34.04/vms/download'].get
$.paths['/api/v34.04/vms/labels'].get
$.paths['/api/v34.04/vms/names'].get
$.paths['/api/v34.04/vms/scan'].post
$.paths['/api/v34.04/vms/stop'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Palo Alto Networks Vms API
  version: 1.0.0
extends: openapi/palo-alto-networks-vms-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['/api/v34.03/vms'].get
  update:
    x-apievangelist-phrasing:
      intent: Get VM image scan results (v34.03)
      effect: read
      questions:
      - What vulnerabilities and compliance issues were found in my VM images on the v34.03 API?
      - Can I filter v34.03 VM image scan results by OS distro?
      - Which VM images failed a given compliance rule according to 34.03?
      instructions:
      - text: Show v34.03 scan results for VM image {name}.
        slots:
          name: query.name
      - text: List 34.03 VM image scan results for distro {distro} with severity {normalizedSeverity}.
        slots:
          distro: query.distro
          normalizedSeverity: query.normalizedSeverity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/vms/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download VM image scan results (v34.03)
      effect: read
      questions:
      - Can I export VM image scan results to a file on the v34.03 API?
      - How do I download 34.03 VM image findings for one cloud credential?
      instructions:
      - text: Download the v34.03 VM image scan results for credential {credential}.
        slots:
          credential: query.credential
      - text: Export 34.03 VM image scan findings of image type {imageType}.
        slots:
          imageType: query.imageType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/vms/labels'].get
  update:
    x-apievangelist-phrasing:
      intent: List VM image tags (v34.03)
      effect: read
      questions:
      - What tags are applied to my scanned VM images on the v34.03 API?
      - Can I see the labels of VM images from one release on 34.03?
      instructions:
      - text: List the v34.03 VM image tags.
      - text: Get 34.03 VM image labels for release {release}.
        slots:
          release: query.release
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/vms/names'].get
  update:
    x-apievangelist-phrasing:
      intent: List scanned VM image names (v34.03)
      effect: read
      questions:
      - Which VM image names have been scanned according to the v34.03 API?
      - Can I get just the names of scanned VM images on 34.03, not full results?
      instructions:
      - text: List v34.03 scanned VM image names.
      - text: Give me 34.03 VM image names for distro {distro}, up to {limit}.
        slots:
          distro: query.distro
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/vms/scan'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a VM image scan (v34.03)
      effect: write
      questions:
      - How do I kick off a VM image scan with the v34.03 API?
      - Can I trigger VM image scanning on demand in version 34.03?
      instructions:
      - text: Start a VM image scan using the v34.03 API.
      - text: Kick off a 34.03 scan of our VM images now.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/vms/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a running VM image scan (v34.03)
      effect: write
      questions:
      - How do I halt an in-progress VM image scan on the v34.03 API?
      - Can I cancel VM image scanning midway with version 34.03?
      instructions:
      - text: Stop the running VM image scan via the v34.03 API.
      - text: Halt the 34.03 VM image scan that's in progress.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/vms'].get
  update:
    x-apievangelist-phrasing:
      intent: Get VM image scan results (v34.04)
      effect: read
      questions:
      - What vulnerabilities were found in my VM images on the current v34.04 API?
      - Can I filter v34.04 VM image scan results by compliance issue type?
      - Which VM images match a specific compliance ID according to 34.04?
      instructions:
      - text: Show v34.04 scan results for VM image {name}.
        slots:
          name: query.name
      - text: List 34.04 VM image scan results with compliance ID {complianceIDs}.
        slots:
          complianceIDs: query.complianceIDs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/vms/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download VM image scan results (v34.04)
      effect: read
      questions:
      - Can I export VM image scan results to a file on the current v34.04 API?
      - How do I download 34.04 VM image findings for one OS release?
      instructions:
      - text: Download the v34.04 VM image scan results for credential {credential}.
        slots:
          credential: query.credential
      - text: Export 34.04 VM image scan findings for release {release}.
        slots:
          release: query.release
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/vms/labels'].get
  update:
    x-apievangelist-phrasing:
      intent: List VM image tags (v34.04)
      effect: read
      questions:
      - What tags are on my scanned VM images on the current v34.04 API?
      - Can I see the labels of one distro's VM images on 34.04?
      instructions:
      - text: List the v34.04 VM image tags.
      - text: Get 34.04 VM image labels for distro {distro}.
        slots:
          distro: query.distro
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/vms/names'].get
  update:
    x-apievangelist-phrasing:
      intent: List scanned VM image names (v34.04)
      effect: read
      questions:
      - Which VM image names have been scanned on the current v34.04 API?
      - Can I list only VM image names of one image type on 34.04?
      instructions:
      - text: List v34.04 scanned VM image names.
      - text: Give me 34.04 VM image names of type {imageType}.
        slots:
          imageType: query.imageType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/vms/scan'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a VM image scan (v34.04)
      effect: write
      questions:
      - How do I kick off a VM image scan with the current v34.04 API?
      - Can I trigger VM image scanning on demand in version 34.04?
      instructions:
      - text: Start a VM image scan using the v34.04 API.
      - text: Kick off a 34.04 scan of our VM images now.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/vms/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a running VM image scan (v34.04)
      effect: write
      questions:
      - How do I halt an in-progress VM image scan on the current v34.04 API?
      - Can I cancel VM image scanning midway with version 34.04?
      instructions:
      - text: Stop the running VM image scan via the v34.04 API.
      - text: Halt the 34.04 VM image scan that's in progress.
      method: generated
      generated: '2026-09-26'