Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Prisma Cloud API Overview Packages API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-packages-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 6

$.info

$.paths['/code/api/v1/vulnerabilities/packages/files/{fileMetadataId}'].get

$.paths['/code/api/v1/vulnerabilities/packages/{packageUuid}/direct-sub-dependencies'].get

$.paths['/code/api/v1/vulnerabilities/packages/{packageUuid}'].get

$.paths['/code/api/v1/vulnerabilities/packages/search'].post

$.paths['/code/api/v1/vulnerabilities/packages/{packageUuid}/cves'].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 Prisma Cloud API Overview Packages API
  version: 1.0.0
extends: openapi/palo-alto-networks-packages-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: 5
- target: $.paths['/code/api/v1/vulnerabilities/packages/files/{fileMetadataId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List packages declared in a file
      effect: read
      questions:
      - Which open source packages come from a specific manifest file in my repo?
      - Can I see only the root-level packages of a file, not transitive ones?
      instructions:
      - text: List packages for file {fileMetadataId}, {limit} at a time from offset {offset}.
        slots:
          fileMetadataId: path.fileMetadataId
          limit: query.limit
          offset: query.offset
      - text: Show only root packages in file {fileMetadataId}, first {limit} starting at {offset}.
        slots:
          fileMetadataId: path.fileMetadataId
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/vulnerabilities/packages/{packageUuid}/direct-sub-dependencies'].get
  update:
    x-apievangelist-phrasing:
      intent: List a package's direct sub-dependencies
      effect: read
      questions:
      - What packages does a given dependency pull in directly?
      - Can I sort a package's direct sub-dependencies by how many errors they have?
      instructions:
      - text: List direct sub-dependencies of package {packageUuid}, {limit} from offset {offset}.
        slots:
          packageUuid: path.packageUuid
          limit: query.limit
          offset: query.offset
      - text: Show the first {limit} direct dependencies of {packageUuid} sorted by {sort}, starting at {offset}.
        slots:
          limit: query.limit
          packageUuid: path.packageUuid
          sort: query.sort
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/vulnerabilities/packages/{packageUuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a package
      effect: read
      questions:
      - What do we know about one specific package in our code scans?
      - How do I fetch a single package's details by UUID?
      instructions:
      - text: Get package {packageUuid}.
        slots:
          packageUuid: path.packageUuid
      - text: Show package {packageUuid} including {include}.
        slots:
          packageUuid: path.packageUuid
          include: query.include
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/vulnerabilities/packages/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search packages across repositories
      effect: read
      questions:
      - Which repositories use a package whose name matches a search term?
      - Can I search packages by status across several repositories at once?
      instructions:
      - text: Search packages matching {q} in repositories {repositories}, {limit} from offset {offset}.
        slots:
          q: requestBody.q
          repositories: requestBody.repositories
          limit: requestBody.limit
          offset: requestBody.offset
      - text: Find packages with statuses {statuses} across repositories {repositories}, returning {limit} from offset {offset}.
        slots:
          statuses: requestBody.statuses
          repositories: requestBody.repositories
          limit: requestBody.limit
          offset: requestBody.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/vulnerabilities/packages/{packageUuid}/cves'].get
  update:
    x-apievangelist-phrasing:
      intent: List CVEs affecting a package
      effect: read
      questions:
      - Which CVEs affect a specific package in my codebase?
      - Can I restrict a package's vulnerabilities to direct ones only?
      instructions:
      - text: List CVEs for package {packageUuid}.
        slots:
          packageUuid: path.packageUuid
      - text: Show only direct CVEs of package {packageUuid} with directOnly {directOnly}.
        slots:
          packageUuid: path.packageUuid
          directOnly: query.directOnly
      method: generated
      generated: '2026-09-26'