# 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 SBOM API
  version: 1.0.0
extends: openapi/palo-alto-networks-sbom-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: 16
- target: $.paths['/code/api/v1/bom/getBOMReport/{repoId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a repository's BOM report
      effect: read
      questions:
      - How do I get a bill of materials report for one of my code repositories?
      - Can I choose the file format and material type of a repo BOM report?
      instructions:
      - text: Get the BOM report for repo {repoId} in {format} covering {material}.
        slots:
          repoId: path.repoId
          format: query.format
          material: query.material
      - text: Export repository {repoId}'s {material} bill of materials as {format}.
        slots:
          repoId: path.repoId
          material: query.material
          format: query.format
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/sbom/dependencies'].post
  update:
    x-apievangelist-phrasing:
      intent: List open-source packages found across VCS
      effect: read
      questions:
      - Which open-source packages are used across my organization's connected repositories?
      - Can I filter and sort the dependency inventory from version control?
      instructions:
      - text: List open-source dependencies matching {filters}, page {page}, {limit} per page.
        slots:
          filters: requestBody.filters
          page: query.page
          limit: query.limit
      - text: Show page {page} of VCS packages ({limit} each) filtered by {filters}, sorted by {sortBy}.
        slots:
          page: query.page
          limit: query.limit
          filters: requestBody.filters
          sortBy: requestBody.sortBy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/sbom/download/cli-images'].get
  update:
    x-apievangelist-phrasing:
      intent: Download SBOMs for CLI-scanned CI images (v34.03)
      effect: read
      questions:
      - How do I pull SBOMs for container images my CI pipeline scanned with twistcli, on v34.03?
      - Can the older API export CI build image SBOMs in a format I choose?
      instructions:
      - text: Download CI-pipeline image SBOMs as {sbomFormat} using v34.03.
        slots:
          sbomFormat: query.sbomFormat
      - text: On v34.03, export the SBOM of CI-scanned image {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/sbom/download/cli-serverless'].get
  update:
    x-apievangelist-phrasing:
      intent: Download SBOMs for CI-scanned functions (v34.03)
      effect: read
      questions:
      - How do I get SBOMs for functions I scanned from the command line in CI, using v34.03?
      - Does the 34.03 API let me export twistcli function scan SBOMs?
      instructions:
      - text: Download twistcli-scanned function SBOMs as {sbomFormat} on v34.03.
        slots:
          sbomFormat: query.sbomFormat
      - text: Using 34.03, export the SBOM for CLI-scanned function {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/sbom/download/hosts'].get
  update:
    x-apievangelist-phrasing:
      intent: Download host SBOMs (v34.03)
      effect: read
      questions:
      - How do I export a software bill of materials for my protected hosts on v34.03?
      - Can I download one host's SBOM by ID using the older API?
      instructions:
      - text: Download host SBOMs as {sbomFormat} using API v34.03.
        slots:
          sbomFormat: query.sbomFormat
      - text: Export the SBOM for host {id} through v34.03.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/sbom/download/images'].get
  update:
    x-apievangelist-phrasing:
      intent: Download deployed image SBOMs (v34.03)
      effect: read
      questions:
      - How do I download SBOMs for container images running in my environment, on v34.03?
      - Can the older API give me a deployed image's SBOM by ID?
      instructions:
      - text: Download deployed container image SBOMs as {sbomFormat} on v34.03.
        slots:
          sbomFormat: query.sbomFormat
      - text: Export the SBOM for running image {id} with API 34.03.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/sbom/download/registry'].get
  update:
    x-apievangelist-phrasing:
      intent: Download registry image SBOMs (v34.03)
      effect: read
      questions:
      - How do I export SBOMs for images stored in my container registries, via v34.03?
      - Can I get a registry image's bill of materials by ID on the older API?
      instructions:
      - text: Download registry image SBOMs as {sbomFormat} with v34.03.
        slots:
          sbomFormat: query.sbomFormat
      - text: Export the SBOM of registry image {id} on API 34.03.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/sbom/download/serverless'].get
  update:
    x-apievangelist-phrasing:
      intent: Download deployed function SBOMs (v34.03)
      effect: read
      questions:
      - How do I export SBOMs for cloud functions discovered in my accounts, on v34.03?
      - Can I download one deployed function's SBOM by ID with the older API?
      instructions:
      - text: Download deployed cloud function SBOMs as {sbomFormat} on v34.03.
        slots:
          sbomFormat: query.sbomFormat
      - text: Export the SBOM of deployed function {id} through 34.03.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/sbom/download/vms'].get
  update:
    x-apievangelist-phrasing:
      intent: Download VM image SBOMs (v34.03)
      effect: read
      questions:
      - How do I export SBOMs for my virtual machine images with v34.03?
      - Can I fetch a single VM image's bill of materials on the older API?
      instructions:
      - text: Download VM image SBOMs as {sbomFormat} on API v34.03.
        slots:
          sbomFormat: query.sbomFormat
      - text: Export the SBOM for VM image {id} via 34.03.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/sbom/download/cli-images'].get
  update:
    x-apievangelist-phrasing:
      intent: Download SBOMs for CLI-scanned CI images (v34.04)
      effect: read
      questions:
      - Where do I export bills of materials for images checked in my CI builds on v34.04?
      - Can I page through CI pipeline image SBOMs on the current 34.04 API?
      instructions:
      - text: Export CI build image SBOMs in {sbomFormat} via version 34.04.
        slots:
          sbomFormat: query.sbomFormat
      - text: With v34.04, get {limit} CI-scanned image SBOMs starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/sbom/download/cli-serverless'].get
  update:
    x-apievangelist-phrasing:
      intent: Download SBOMs for CI-scanned functions (v34.04)
      effect: read
      questions:
      - Where are SBOMs for command-line function scans on the 34.04 API?
      - Can I sort the twistcli function SBOM export in v34.04?
      instructions:
      - text: Export command-line function scan SBOMs in {sbomFormat} with v34.04.
        slots:
          sbomFormat: query.sbomFormat
      - text: On 34.04, list twistcli function SBOMs sorted by {sort}, reversed {reverse}.
        slots:
          sort: query.sort
          reverse: query.reverse
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/sbom/download/hosts'].get
  update:
    x-apievangelist-phrasing:
      intent: Download host SBOMs (v34.04)
      effect: read
      questions:
      - What packages are installed on my hosts, as an SBOM from v34.04?
      - Can I page host SBOM downloads with offset and limit on version 34.04?
      instructions:
      - text: Export host SBOMs in {sbomFormat} via version 34.04.
        slots:
          sbomFormat: query.sbomFormat
      - text: Get {limit} host SBOMs from offset {offset} on v34.04.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/sbom/download/images'].get
  update:
    x-apievangelist-phrasing:
      intent: Download deployed image SBOMs (v34.04)
      effect: read
      questions:
      - Where can I get bills of materials for deployed containers on the 34.04 API?
      - Can I sort the deployed container image SBOM export on v34.04?
      instructions:
      - text: Export running container image SBOMs in {sbomFormat} using v34.04.
        slots:
          sbomFormat: query.sbomFormat
      - text: On v34.04, list deployed image SBOMs sorted by {sort}.
        slots:
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/sbom/download/registry'].get
  update:
    x-apievangelist-phrasing:
      intent: Download registry image SBOMs (v34.04)
      effect: read
      questions:
      - Where do I get SBOMs for scanned registry repositories on v34.04?
      - Can I page through registry SBOMs on the current API version?
      instructions:
      - text: Export container registry SBOMs in {sbomFormat} via 34.04.
        slots:
          sbomFormat: query.sbomFormat
      - text: Get {limit} registry image SBOMs from offset {offset} using v34.04.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/sbom/download/serverless'].get
  update:
    x-apievangelist-phrasing:
      intent: Download deployed function SBOMs (v34.04)
      effect: read
      questions:
      - Where can I get bills of materials for functions deployed in my cloud accounts on v34.04?
      - Can I reverse-sort the deployed function SBOM export in 34.04?
      instructions:
      - text: Export deployed cloud function SBOMs in {sbomFormat} with v34.04.
        slots:
          sbomFormat: query.sbomFormat
      - text: On 34.04, list deployed function SBOMs sorted by {sort}, reverse {reverse}.
        slots:
          sort: query.sort
          reverse: query.reverse
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/sbom/download/vms'].get
  update:
    x-apievangelist-phrasing:
      intent: Download VM image SBOMs (v34.04)
      effect: read
      questions:
      - Where do I get software bills of materials for VM images on the 34.04 API?
      - Can I page through virtual machine SBOMs with offset and limit in v34.04?
      instructions:
      - text: Export virtual machine image SBOMs in {sbomFormat} using v34.04.
        slots:
          sbomFormat: query.sbomFormat
      - text: Get {limit} VM image SBOMs from offset {offset} on version 34.04.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-09-26'