Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks Compliance Analytics API

11 actions 11 updates phrasing extends openapi/palo-alto-networks-compliance-analytics-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 11

$.info
$.paths['/summaries'].get
$.paths['/overall-compliance/{id}'].get
$.paths['/overall-compliance-timeline/{id}'].get
$.paths['/configurations-assessed/{id}'].get
$.paths['/compliance-controls/{id}'].get
$.paths['/compliance-frameworks/v1/summaries'].get
$.paths['/compliance-frameworks/v1/overall-compliance/{id}'].get
$.paths['/compliance-frameworks/v1/overall-compliance-timeline/{id}'].get
$.paths['/compliance-frameworks/v1/configurations-assessed/{id}'].get
$.paths['/compliance-frameworks/v1/compliance-controls/{id}'].get

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 Compliance Analytics API
  version: 1.0.0
extends: openapi/palo-alto-networks-compliance-analytics-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: 10
- target: $.paths['/summaries'].get
  update:
    x-apievangelist-phrasing:
      intent: List compliance framework summaries (legacy path)
      effect: read
      questions:
      - How do I get a summary of compliance frameworks from the older unversioned summaries endpoint?
      - Can the legacy summaries call filter frameworks by product type?
      instructions:
      - text: List compliance framework summaries for product {product} using the legacy endpoint.
        slots:
          product: query.product
      - text: Show all framework summaries from the unversioned summaries path.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/overall-compliance/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a framework's compliance scores (legacy path)
      effect: read
      questions:
      - What are the overall compliance scores for a framework via the older unversioned call?
      - Can I see a framework's scores across products and categories with the legacy API?
      instructions:
      - text: Get overall compliance scores for framework {id} from the legacy endpoint.
        slots:
          id: path.id
      - text: Show framework {id}'s scores by product and category, unversioned path.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/overall-compliance-timeline/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a 30-day compliance timeline (legacy path)
      effect: read
      questions:
      - How has a framework's compliance score trended over the last 30 days on the legacy API?
      - Can I narrow the older 30-day compliance timeline to one product?
      instructions:
      - text: Show the 30-day compliance timeline for framework {id} via the legacy path.
        slots:
          id: path.id
      - text: Get framework {id}'s legacy 30-day score trend for product {product}.
        slots:
          id: path.id
          product: query.product
      method: generated
      generated: '2026-09-26'
- target: $.paths['/configurations-assessed/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get assessed configurations (legacy path)
      effect: read
      questions:
      - Which configurations were assessed for a framework using the unversioned endpoint?
      - Can I filter the legacy assessed-configurations list by product?
      instructions:
      - text: List assessed configurations for framework {id} on the legacy endpoint.
        slots:
          id: path.id
      - text: Get legacy assessed configurations for framework {id} and product {product}.
        slots:
          id: path.id
          product: query.product
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compliance-controls/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a framework's controls (legacy path)
      effect: read
      questions:
      - What controls make up a compliance framework, using the older unversioned call?
      - Can I list a framework's controls for one product on the legacy API?
      instructions:
      - text: List compliance controls for framework {id} from the legacy path.
        slots:
          id: path.id
      - text: Show legacy controls for framework {id} filtered to {product}.
        slots:
          id: path.id
          product: query.product
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compliance-frameworks/v1/summaries'].get
  update:
    x-apievangelist-phrasing:
      intent: List compliance framework summaries (v1)
      effect: read
      questions:
      - Which compliance frameworks are available, summarized per current revision in v1?
      - Can I group v1 framework summaries by product type?
      instructions:
      - text: List v1 compliance framework summaries for product {product}.
        slots:
          product: query.product
      - text: Summarize every compliance framework using the v1 API.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compliance-frameworks/v1/overall-compliance/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a framework's compliance scores (v1)
      effect: read
      questions:
      - How compliant am I with a given framework overall, per the v1 API?
      - Does the v1 scores call break results down by product and category?
      instructions:
      - text: Get v1 overall compliance scores for framework {id}.
        slots:
          id: path.id
      - text: Show how framework {id} scores across products using v1.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compliance-frameworks/v1/overall-compliance-timeline/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a compliance score timeline up to a year (v1)
      effect: read
      questions:
      - Can I see a framework's compliance trend over a full year, not just 30 days?
      - How has my score changed over 30 days and 1 year for one product in v1?
      instructions:
      - text: Show the v1 compliance timeline over 30 days and 1 year for framework {id}.
        slots:
          id: path.id
      - text: Get framework {id}'s one-year score history for product {product}.
        slots:
          id: path.id
          product: query.product
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compliance-frameworks/v1/configurations-assessed/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get assessed configurations for a framework (v1)
      effect: read
      questions:
      - What configurations did the v1 compliance API assess against a framework?
      - Can I see v1 assessed configurations for one product only?
      instructions:
      - text: List v1 assessed configurations for framework {id}.
        slots:
          id: path.id
      - text: Get configurations assessed under framework {id} for {product} with v1.
        slots:
          id: path.id
          product: query.product
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compliance-frameworks/v1/compliance-controls/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a framework's controls (v1)
      effect: read
      questions:
      - Which controls belong to a compliance framework in the v1 API?
      - Can I filter v1 framework controls by product?
      instructions:
      - text: List v1 compliance controls for framework {id}.
        slots:
          id: path.id
      - text: Show framework {id}'s v1 controls for product {product}.
        slots:
          id: path.id
          product: query.product
      method: generated
      generated: '2026-09-26'