Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks Registry API

21 actions 21 updates phrasing extends openapi/palo-alto-networks-registry-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 21 · first 16 shown; the file carries all of them

$.info
$.paths['/api/v1/registry/webhook/webhook'].post
$.paths['/api/v1/registry/webhook/webhook'].delete
$.paths['/api/v34.03/registry'].get
$.paths['/api/v34.03/registry/download'].get
$.paths['/api/v34.03/registry/names'].get
$.paths['/api/v34.03/registry/progress'].get
$.paths['/api/v34.03/registry/scan'].post
$.paths['/api/v34.03/registry/scan/select'].post
$.paths['/api/v34.03/registry/stop'].post
$.paths['/api/v34.03/registry/stop/{id}'].post
$.paths['/api/v34.04/registry'].get
$.paths['/api/v34.04/registry/download'].get
$.paths['/api/v34.04/registry/names'].get
$.paths['/api/v34.04/registry/progress'].get
$.paths['/api/v34.04/registry/scan'].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 Registry API
  version: 1.0.0
extends: openapi/palo-alto-networks-registry-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: 20
- target: $.paths['/api/v1/registry/webhook/webhook'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a registry webhook event
      effect: write
      questions:
      - Can a container registry push an event to Prisma Cloud Compute through a webhook?
      - Which fields does the registry webhook accept, like event type, action and domain?
      instructions:
      - text: Post a registry webhook event of type {event_type} with action {action}.
        slots:
          event_type: requestBody.event_type
          action: requestBody.action
      - text: Notify the registry webhook about an Artifactory push from domain {domain}.
        slots:
          domain: requestBody.domain
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/registry/webhook/webhook'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove the registry webhook
      effect: destructive
      questions:
      - How can I turn off the registry webhook so registries stop pushing events?
      - Is there a way to delete the registry webhook configuration entirely?
      instructions:
      - text: Delete the registry webhook.
      - text: Remove the webhook that receives registry push events.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/registry'].get
  update:
    x-apievangelist-phrasing:
      intent: Get registry scan results (v34.03)
      effect: read
      questions:
      - Where can I see registry image scan results using the v34.03 API version?
      - Can I filter v34.03 registry scan results by repository and severity?
      instructions:
      - text: On API v34.03, show registry scan results for repository {repository}.
        slots:
          repository: query.repository
      - text: Fetch v34.03 registry scan findings for image {imageID}.
        slots:
          imageID: query.imageID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/registry/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download registry scan results (v34.03)
      effect: read
      questions:
      - Can I export registry scan findings to a file with the older v34.03 endpoint?
      - Is it possible to download v34.03 registry results for only one registry?
      instructions:
      - text: Download the v34.03 registry scan report for registry {registry}.
        slots:
          registry: query.registry
      - text: Export all registry scan results as a file via API version 34.03.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/registry/names'].get
  update:
    x-apievangelist-phrasing:
      intent: List registry image names (v34.03)
      effect: read
      questions:
      - What image names has the registry scanner found, per the v34.03 API?
      - Can I get just the image names from registry scans on version 34.03?
      instructions:
      - text: List scanned registry image names in repository {repository} using v34.03.
        slots:
          repository: query.repository
      - text: Give me only the names of registry images, older v34.03 endpoint.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/registry/progress'].get
  update:
    x-apievangelist-phrasing:
      intent: Check registry scan progress (v34.03)
      effect: read
      questions:
      - Is my registry scan still running, according to the v34.03 progress endpoint?
      - How far along is the on-demand registry scan under API v34.03?
      instructions:
      - text: Show v34.03 scan progress for registry {registry}.
        slots:
          registry: query.registry
      - text: Check how far the v34.03 scan of repo {repo} tag {tag} has gotten.
        slots:
          repo: query.repo
          tag: query.tag
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/registry/scan'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a registry scan (v34.03)
      effect: write
      questions:
      - Can I kick off a registry scan on demand through the v34.03 API?
      - Could I rescan one tagged image in a registry using version 34.03?
      instructions:
      - text: Start an on-demand registry scan with the v34.03 API.
      - text: Trigger a v34.03 registry scan for tag {tag}.
        slots:
          tag: requestBody.tag
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/registry/scan/select'].post
  update:
    x-apievangelist-phrasing:
      intent: Scan selected registries (v34.03)
      effect: write
      questions:
      - Can I scan only a chosen set of registries rather than all of them on v34.03?
      - Which v34.03 call scans a selection of registries at once?
      instructions:
      - text: Scan the selected registries using the v34.03 select endpoint.
      - text: Run a v34.03 scan against just the registries I picked.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/registry/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop all registry scanning (v34.03)
      effect: destructive
      questions:
      - Can I halt a running registry scan with the v34.03 API?
      - What stops every in-progress registry scan on version 34.03?
      instructions:
      - text: Stop the running registry scan via v34.03.
      - text: Halt all ongoing registry scanning, API version 34.03.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/registry/stop/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop one registry spec scan (v34.03)
      effect: destructive
      questions:
      - Can I stop the scan of just one registry specification on v34.03?
      - Is there a way to cancel a single registry spec scan by its ID in version 34.03?
      instructions:
      - text: Stop the v34.03 registry spec scan {id}.
        slots:
          id: path.id
      - text: Cancel scanning of registry specification {id} with API v34.03.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/registry'].get
  update:
    x-apievangelist-phrasing:
      intent: Get registry scan results
      effect: read
      questions:
      - What vulnerabilities did the latest registry scans find in my images?
      - Can I narrow registry scan results to one registry and a minimum severity?
      instructions:
      - text: Show registry scan results for registry {registry}.
        slots:
          registry: query.registry
      - text: Get registry scan findings with severity {normalizedSeverity}, v34.04.
        slots:
          normalizedSeverity: query.normalizedSeverity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/registry/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download registry scan results
      effect: read
      questions:
      - How do I export registry image scan results as a downloadable file?
      - Can I download registry findings filtered to a single repository in v34.04?
      instructions:
      - text: Download registry scan results for repository {repository} as a file.
        slots:
          repository: query.repository
      - text: Export the current registry scan report on API version 34.04.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/registry/names'].get
  update:
    x-apievangelist-phrasing:
      intent: List registry image names
      effect: read
      questions:
      - Which image names exist across my scanned registries?
      - Can I pull a plain list of registry image names without full scan detail on v34.04?
      instructions:
      - text: List the image names found in registry {registry}.
        slots:
          registry: query.registry
      - text: Return just the names of scanned registry images, latest v34.04 API.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/registry/progress'].get
  update:
    x-apievangelist-phrasing:
      intent: Check registry scan progress
      effect: read
      questions:
      - How far along is the current registry scan?
      - Can I check scan progress for one image digest in a registry?
      instructions:
      - text: Show registry scan progress for digest {digest}.
        slots:
          digest: query.digest
      - text: Report the progress of the on-demand registry scan for repo {repo}, v34.04.
        slots:
          repo: query.repo
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/registry/scan'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a registry scan
      effect: write
      questions:
      - Can I trigger a registry scan right now instead of waiting for the schedule?
      - Is it possible to scan a single image tag in a registry on demand?
      instructions:
      - text: Start a registry scan now.
      - text: Kick off an on-demand registry scan of tag {tag} on API v34.04.
        slots:
          tag: requestBody.tag
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/registry/scan/select'].post
  update:
    x-apievangelist-phrasing:
      intent: Scan selected registries
      effect: write
      questions:
      - Can I run a scan across only a few specific registries?
      - What is the call to scan a chosen subset of registries in v34.04?
      instructions:
      - text: Scan only the registries I selected.
      - text: Launch a scan for my picked registries using the current v34.04 API.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/registry/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop all registry scanning
      effect: destructive
      questions:
      - How can I stop a registry scan that is taking too long?
      - Can I abort all registry scans currently in progress on v34.04?
      instructions:
      - text: Stop the registry scan that is running.
      - text: Abort every in-progress registry scan with the v34.04 API.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/registry/stop/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop one registry spec scan
      effect: destructive
      questions:
      - Can I stop scanning just one registry specification while others keep going?
      - Is there a call to cancel a registry spec scan by ID on v34.04?
      instructions:
      - text: Stop the scan for registry specification {id}.
        slots:
          id: path.id
      - text: Cancel registry spec scan {id} using API version 34.04.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/registry'].get
  update:
    x-apievangelist-phrasing:
      intent: List configured registries
      effect: read
      questions:
      - Which container registries are set up for scanning in Prisma Cloud Compute?
      - What schedule and scope does each configured registry use?
      instructions:
      - text: List all container registries configured for scanning.
      - text: Show me the registry scanning configuration with credentials and schedules.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/registry'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a registry to scanning
      effect: write
      questions:
      - Can I add a new ECR or Docker Hub registry to be scanned?
      - What do I need to register a container registry for vulnerability scanning?
      instructions:
      - text: Add registry {registry} of type {version} to the scan configuration.
        slots:
          registry: requestBody.registry
          version: requestBody.version
      - text: Register {registry} for scanning using credential {credentialID}, type {version}.
        slots:
          registry: requestBody.registry
          credentialID: requestBody.credentialID
          version: requestBody.version
      method: generated
      generated: '2026-09-26'