Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks Asset Inventory API

16 actions 16 updates phrasing extends openapi/palo-alto-networks-asset-inventory-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['/filter/v2/inventory/suggest'].get
$.paths['/filter/v2/inventory/suggest'].post
$.paths['/filter/inventory'].get
$.paths['/filter/inventory'].post
$.paths['/filter/inventory/{id}'].get
$.paths['/filter/inventory/{id}'].put
$.paths['/filter/inventory/{id}'].delete
$.paths['/v2/inventory'].get
$.paths['/v2/inventory'].post
$.paths['/v2/inventory/trend'].get
$.paths['/v2/inventory/trend'].post
$.paths['/v3/inventory'].get
$.paths['/v3/inventory'].post
$.paths['/v3/inventory/trend'].get
$.paths['/v3/inventory/trend'].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 Asset Inventory API
  version: 1.0.0
extends: openapi/palo-alto-networks-asset-inventory-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['/filter/v2/inventory/suggest'].get
  update:
    x-apievangelist-phrasing:
      intent: List asset inventory filters
      effect: read
      questions:
      - Which filters can I apply to the Prisma Cloud asset inventory?
      - What recent default options exist for each inventory filter?
      instructions:
      - text: List the supported asset inventory filters and their default options.
      - text: Show me which filter names the inventory views accept.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filter/v2/inventory/suggest'].post
  update:
    x-apievangelist-phrasing:
      intent: Suggest values for an inventory filter
      effect: read
      questions:
      - Can I get autocomplete suggestions for an asset inventory filter?
      - What values match a partial string for the cloud.region inventory filter?
      instructions:
      - text: Suggest values for inventory filter {filterName}.
        slots:
          filterName: requestBody.filterName
      - text: Autocomplete {query} for inventory filter {filterName}.
        slots:
          query: requestBody.query
          filterName: requestBody.filterName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filter/inventory'].get
  update:
    x-apievangelist-phrasing:
      intent: List saved asset inventory filters
      effect: read
      questions:
      - What asset inventory filters have we saved?
      - Can I see every saved inventory filter in the tenant?
      instructions:
      - text: List all saved asset inventory filters.
      - text: Show my saved inventory filter presets.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filter/inventory'].post
  update:
    x-apievangelist-phrasing:
      intent: Save an asset inventory filter
      effect: write
      questions:
      - How do I save an asset inventory filter so I can reuse it later?
      - Can a saved inventory filter remember a group-by setting?
      instructions:
      - text: Save an asset inventory filter using filters {filters}.
        slots:
          filters: requestBody.filters
      - text: Save a new inventory filter grouped by {groupBy}.
        slots:
          groupBy: requestBody.groupBy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filter/inventory/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a saved asset inventory filter
      effect: read
      questions:
      - What criteria does one of my saved inventory filters contain?
      - Can I fetch a single saved asset inventory filter by its ID?
      instructions:
      - text: Get saved asset inventory filter {id}.
        slots:
          id: path.id
      - text: Show the filters stored in saved inventory filter {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filter/inventory/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a saved asset inventory filter
      effect: write
      questions:
      - How do I change the criteria of an inventory filter I already saved?
      - Can I change the sort order stored in an existing saved filter?
      instructions:
      - text: Update saved inventory filter {id} to use filters {filters}.
        slots:
          id: path.id
          filters: requestBody.filters
      - text: Change the sort of saved inventory filter {id} to {sortBy}.
        slots:
          id: path.id
          sortBy: requestBody.sortBy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filter/inventory/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a saved asset inventory filter
      effect: destructive
      questions:
      - How do I delete a saved asset inventory filter?
      - Is removing a saved inventory filter permanent?
      instructions:
      - text: Delete saved asset inventory filter {id}.
        slots:
          id: path.id
      - text: Remove the saved inventory filter with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/inventory'].get
  update:
    x-apievangelist-phrasing:
      intent: Get asset pass/fail inventory for a period (v2)
      effect: read
      questions:
      - How many assets passed or failed scans over the last 30 days, using the legacy v2 view?
      - Can the deprecated v2 inventory view be filtered by compliance standard?
      instructions:
      - text: Get v2 asset inventory for the last {timeAmount} {timeUnit} with time type {timeType}.
        slots:
          timeAmount: query.timeAmount
          timeUnit: query.timeUnit
          timeType: query.timeType
      - text: Show v2 inventory pass/fail for the past {timeAmount} {timeUnit} ({timeType}) in cloud account {account}.
        slots:
          timeAmount: query.timeAmount
          timeUnit: query.timeUnit
          timeType: query.timeType
          account: query.cloud.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/inventory'].post
  update:
    x-apievangelist-phrasing:
      intent: Query asset inventory with a body filter (v2)
      effect: read
      questions:
      - Can I send a JSON filter body to the older v2 asset inventory view?
      - Which fields can I ask for from the v2 POST inventory query?
      instructions:
      - text: Query the v2 asset inventory with filters {filters}.
        slots:
          filters: requestBody.filters
      - text: Run the v2 POST inventory view for time range {timeRange}.
        slots:
          timeRange: requestBody.timeRange
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/inventory/trend'].get
  update:
    x-apievangelist-phrasing:
      intent: Get asset inventory trend for a period (v2)
      effect: read
      questions:
      - How has my asset pass/fail count trended in the legacy v2 trend view?
      - Can the v2 inventory trend be narrowed to one compliance section?
      instructions:
      - text: Get the v2 inventory trend for the last {timeAmount} {timeUnit}, time type {timeType}.
        slots:
          timeAmount: query.timeAmount
          timeUnit: query.timeUnit
          timeType: query.timeType
      - text: Show the v2 asset trend over {timeAmount} {timeUnit} ({timeType}) for region {region}.
        slots:
          timeAmount: query.timeAmount
          timeUnit: query.timeUnit
          timeType: query.timeType
          region: query.cloud.region
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/inventory/trend'].post
  update:
    x-apievangelist-phrasing:
      intent: Query asset inventory trend with a body (v2)
      effect: read
      questions:
      - Can I post a filter body to get the legacy v2 inventory trend?
      - Does the v2 POST trend view accept a time range in the body?
      instructions:
      - text: Query the v2 inventory trend with filters {filters}.
        slots:
          filters: requestBody.filters
      - text: Get the v2 POST asset trend over time range {timeRange}.
        slots:
          timeRange: requestBody.timeRange
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/inventory'].get
  update:
    x-apievangelist-phrasing:
      intent: Get asset pass/fail inventory (v3)
      effect: read
      questions:
      - How many of my cloud assets are passing or failing policy scans right now?
      - Can I group current inventory results by cloud type or region?
      instructions:
      - text: Get the asset inventory grouped by {groupBy}.
        slots:
          groupBy: query.groupBy
      - text: Show inventory pass/fail for resource type {resourceType}.
        slots:
          resourceType: query.resource.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/inventory'].post
  update:
    x-apievangelist-phrasing:
      intent: Query asset inventory with a body filter (v3)
      effect: read
      questions:
      - Can I query the current inventory view with a JSON filter body?
      - What is the paginated way to query asset inventory with a page token?
      instructions:
      - text: Query asset inventory with body filters {filters}.
        slots:
          filters: requestBody.filters
      - text: Continue the inventory query from page token {pageToken}.
        slots:
          pageToken: requestBody.pageToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/inventory/trend'].get
  update:
    x-apievangelist-phrasing:
      intent: Get asset inventory trend (v3)
      effect: read
      questions:
      - How is my asset compliance trending over time?
      - Can I see the pass/fail trend for one cloud account only?
      instructions:
      - text: Show the asset inventory trend for account group {group}.
        slots:
          group: query.account.group
      - text: Get the inventory pass/fail trend for policy severity {severity}.
        slots:
          severity: query.asset.severity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/inventory/trend'].post
  update:
    x-apievangelist-phrasing:
      intent: Query asset inventory trend with a body (v3)
      effect: read
      questions:
      - Can I post filters to get the current asset trend view?
      - Is there a body-based query for inventory trends that returns only certain fields?
      instructions:
      - text: Query the asset trend with body filters {filters}.
        slots:
          filters: requestBody.filters
      - text: Get the inventory trend returning only fields {fields}.
        slots:
          fields: requestBody.fields
      method: generated
      generated: '2026-09-26'