Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks Collections API

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

$.info
$.paths['/api/v34.03/collections'].get
$.paths['/api/v34.03/collections'].post
$.paths['/api/v34.03/collections/{id}'].put
$.paths['/api/v34.03/collections/{id}'].delete
$.paths['/api/v34.03/collections/{id}/usages'].get
$.paths['/api/v34.04/collections'].get
$.paths['/api/v34.04/collections'].post
$.paths['/api/v34.04/collections/{id}'].put
$.paths['/api/v34.04/collections/{id}'].delete
$.paths['/api/v34.04/collections/{id}/usages'].get
$.paths['/entitlement/api/v1/collection/{id}'].get
$.paths['/entitlement/api/v1/collection/{id}'].put
$.paths['/entitlement/api/v1/collection/{id}'].delete
$.paths['/entitlement/api/v1/collection'].get
$.paths['/entitlement/api/v1/collection'].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 Collections API
  version: 1.0.0
extends: openapi/palo-alto-networks-collections-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: 15
- target: $.paths['/api/v34.03/collections'].get
  update:
    x-apievangelist-phrasing:
      intent: List Compute collections (v34.03)
      effect: read
      questions:
      - Which Compute collections exist when I call the v34.03 API?
      - Can I leave out collections that came from Prisma Cloud on v34.03?
      instructions:
      - text: List all Compute collections using API v34.03.
      - text: Get v34.03 collections with excludePrisma set to {excludePrisma}.
        slots:
          excludePrisma: query.excludePrisma
      - text: Show only system-created collections from v34.03 (system={system}).
        slots:
          system: query.system
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/collections'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a Compute collection (v34.03)
      effect: write
      questions:
      - How do I group images and hosts into a new collection on v34.03?
      - Must a collection name be unique when I add one through v34.03?
      instructions:
      - text: Add a v34.03 collection named {name} covering images {images}.
        slots:
          name: requestBody.name
          images: requestBody.images
      - text: Via v34.03, create collection {name} scoped to clusters {clusters} and namespaces {namespaces}.
        slots:
          name: requestBody.name
          clusters: requestBody.clusters
          namespaces: requestBody.namespaces
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/collections/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Compute collection (v34.03)
      effect: write
      questions:
      - Can I change which hosts belong to an existing collection on v34.03?
      - How do I edit a collection's labels through the v34.03 API?
      instructions:
      - text: Update v34.03 collection {id} to include hosts {hosts}.
        slots:
          id: path.id
          hosts: requestBody.hosts
      - text: Using v34.03, set the labels of collection {id} to {labels}.
        slots:
          id: path.id
          labels: requestBody.labels
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/collections/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Compute collection (v34.03)
      effect: destructive
      questions:
      - How do I delete a Compute collection with the v34.03 API?
      - Can v34.03 remove a collection I no longer scope policies to?
      instructions:
      - text: Delete v34.03 collection {id}.
        slots:
          id: path.id
      - text: Remove Compute collection {id} through API version 34.03.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/collections/{id}/usages'].get
  update:
    x-apievangelist-phrasing:
      intent: See which policies use a collection (v34.03)
      effect: read
      questions:
      - Which policies reference a given collection, using v34.03?
      - Before deleting a collection, can v34.03 tell me where it's used?
      instructions:
      - text: List the policies that use collection {id} via v34.03.
        slots:
          id: path.id
      - text: Show v34.03 usages of collection {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/collections'].get
  update:
    x-apievangelist-phrasing:
      intent: List Compute collections (v34.04)
      effect: read
      questions:
      - What collections are configured in Compute on the v34.04 API?
      - Can I fetch only Prisma Cloud-originated collections on version 34.04?
      instructions:
      - text: Retrieve every collection from the v34.04 Compute endpoint.
      - text: Get collections on v34.04 filtered by prisma={prisma}.
        slots:
          prisma: query.prisma
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/collections'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a Compute collection (v34.04)
      effect: write
      questions:
      - How do I create a collection of containers and functions on v34.04?
      - Can a v34.04 collection be scoped to cloud account IDs?
      instructions:
      - text: Create collection {name} with the v34.04 API.
        slots:
          name: requestBody.name
      - text: On v34.04, add collection {name} for account IDs {accountIDs} and functions {functions}.
        slots:
          name: requestBody.name
          accountIDs: requestBody.accountIDs
          functions: requestBody.functions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/collections/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Compute collection (v34.04)
      effect: write
      questions:
      - How do I change the containers in an existing collection on version 34.04?
      - Can v34.04 update a collection's description and color?
      instructions:
      - text: With v34.04, set containers {containers} on collection {id}.
        slots:
          containers: requestBody.containers
          id: path.id
      - text: Change the description of v34.04 collection {id} to {description}.
        slots:
          id: path.id
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/collections/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Compute collection (v34.04)
      effect: destructive
      questions:
      - Is there a v34.04 call to permanently delete a collection?
      - How do I drop an unused Compute collection on the current API version?
      instructions:
      - text: Delete collection {id} using the v34.04 Compute API.
        slots:
          id: path.id
      - text: Drop Compute collection {id} (v34.04).
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/collections/{id}/usages'].get
  update:
    x-apievangelist-phrasing:
      intent: See which policies use a collection (v34.04)
      effect: read
      questions:
      - What policies depend on this collection in v34.04?
      - Can I get the policy usages of a collection from the v34.04 API?
      instructions:
      - text: With v34.04, show which policies reference collection {id}.
        slots:
          id: path.id
      - text: Get policy usages for collection {id} on API v34.04.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/entitlement/api/v1/collection/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an asset-group collection by ID
      effect: read
      questions:
      - How do I see the asset groups inside one entitlement collection?
      - Who created and last modified a given Darwin collection?
      instructions:
      - text: Get all details of entitlement collection {id}.
        slots:
          id: path.id
      - text: Show the asset groups in Darwin collection {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/entitlement/api/v1/collection/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an asset-group collection
      effect: write
      questions:
      - Can I change the asset groups in an entitlement collection?
      - How do I rename a collection on the Darwin release?
      instructions:
      - text: Rename entitlement collection {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Replace the asset groups of Darwin collection {id} with {assetGroups}.
        slots:
          id: path.id
          assetGroups: requestBody.assetGroups
      method: generated
      generated: '2026-09-26'
- target: $.paths['/entitlement/api/v1/collection/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an asset-group collection
      effect: destructive
      questions:
      - How do I delete an entitlement collection on the Darwin release?
      - Can I remove a collection of asset groups by its ID?
      instructions:
      - text: Delete entitlement collection {id}.
        slots:
          id: path.id
      - text: Remove the Darwin asset-group collection {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/entitlement/api/v1/collection'].get
  update:
    x-apievangelist-phrasing:
      intent: List asset-group collections
      effect: read
      questions:
      - What entitlement collections do I have, and how many can I fetch per page?
      - Can I list Darwin collections without their asset groups to keep responses small?
      - Is it possible to sort entitlement collections by name or last modified time?
      instructions:
      - text: List entitlement collections, {page_size} per page, ordered by {order_by}.
        slots:
          page_size: query.page_size
          order_by: query.order_by
      - text: Fetch the next page of Darwin collections using token {next_page_token}.
        slots:
          next_page_token: query.next_page_token
      - text: List all entitlement collections, excluding asset groups.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/entitlement/api/v1/collection'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an asset-group collection
      effect: write
      questions:
      - How do I create an entitlement collection made of asset group types?
      - Can I use a wildcard to include every ID of an asset group type in a new collection?
      instructions:
      - text: Create entitlement collection {name} with asset groups {assetGroups}.
        slots:
          name: requestBody.name
          assetGroups: requestBody.assetGroups
      - text: Set up a Darwin collection {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'