Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks Compliance Posture API

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

$.info
$.paths['/compliance/posture'].get
$.paths['/compliance/posture'].post
$.paths['/compliance/posture/{complianceId}'].get
$.paths['/compliance/posture/{complianceId}'].post
$.paths['/compliance/posture/{complianceId}/{requirementId}'].get
$.paths['/compliance/posture/{complianceId}/{requirementId}'].post
$.paths['/compliance/posture/trend'].get
$.paths['/compliance/posture/trend'].post
$.paths['/compliance/posture/trend/{complianceId}'].get
$.paths['/compliance/posture/trend/{complianceId}'].post
$.paths['/compliance/posture/trend/{complianceId}/{requirementId}'].get
$.paths['/compliance/posture/trend/{complianceId}/{requirementId}'].post
$.paths['/filter/compliance/posture/suggest'].get
$.paths['/filter/compliance/posture/suggest'].post
$.paths['/v2/compliance/posture'].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 Posture API
  version: 1.0.0
extends: openapi/palo-alto-networks-compliance-posture-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: 26
- target: $.paths['/compliance/posture'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the v1 compliance pass/fail breakdown
      effect: read
      questions:
      - How do I get passed and failed counts across all my compliance standards for the last few days using the original v1 posture endpoint?
      - Can the legacy compliance statistics GET call be narrowed to one cloud account or region with a relative time window?
      instructions:
      - text: Using the v1 GET compliance posture call, show pass/fail stats for all standards over the last {timeAmount} {timeUnit} ({timeType} time).
        slots:
          timeAmount: query.timeAmount
          timeUnit: query.timeUnit
          timeType: query.timeType
      - text: Pull the v1 compliance breakdown for cloud account {account}, {timeType} time, last {timeAmount} {timeUnit}.
        slots:
          account: query.cloud.account
          timeType: query.timeType
          timeAmount: query.timeAmount
          timeUnit: query.timeUnit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compliance/posture'].post
  update:
    x-apievangelist-phrasing:
      intent: Query the v1 compliance breakdown with body filters
      effect: read
      questions:
      - Is there a POST version of the old compliance statistics breakdown that takes filters and a time range in the request body?
      - Can I choose which fields come back when I request the v1 all-standards compliance breakdown by POST?
      instructions:
      - text: POST to the v1 compliance posture endpoint with filters {filters} and time range {timeRange} to get the all-standards breakdown.
        slots:
          filters: requestBody.filters
          timeRange: requestBody.timeRange
      - text: Request only fields {fields} from the v1 all-standards compliance breakdown via POST.
        slots:
          fields: requestBody.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compliance/posture/{complianceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get v1 compliance stats for one standard
      effect: read
      questions:
      - What are the passed and failed results for a single compliance standard over a set time window in the v1 API?
      - Can I break down one standard's compliance by requirement for a specific cloud type using the older GET endpoint?
      instructions:
      - text: Get v1 pass/fail statistics for compliance standard {complianceId} over the last {timeAmount} {timeUnit} ({timeType}).
        slots:
          complianceId: path.complianceId
          timeAmount: query.timeAmount
          timeUnit: query.timeUnit
          timeType: query.timeType
      - text: Show v1 compliance stats for standard {complianceId} on cloud type {cloudType}, {timeType} time, {timeAmount} {timeUnit}.
        slots:
          complianceId: path.complianceId
          cloudType: query.cloud.type
          timeType: query.timeType
          timeAmount: query.timeAmount
          timeUnit: query.timeUnit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compliance/posture/{complianceId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Query v1 compliance stats for a standard by POST
      effect: read
      questions:
      - Can I send body filters and a time range when fetching one standard's compliance statistics in the legacy API?
      - Which POST call returns the v1 pass/fail breakdown for a single compliance standard ID?
      instructions:
      - text: POST a v1 statistics request for compliance standard {complianceId} with time range {timeRange}.
        slots:
          complianceId: path.complianceId
          timeRange: requestBody.timeRange
      - text: Fetch the v1 breakdown for standard {complianceId} filtered by {filters} using the POST form.
        slots:
          complianceId: path.complianceId
          filters: requestBody.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compliance/posture/{complianceId}/{requirementId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get v1 compliance stats for one requirement
      effect: read
      questions:
      - How can I see section-level pass/fail results for one requirement inside a compliance standard with the v1 API?
      - Can the legacy requirement statistics GET be limited to a single compliance section?
      instructions:
      - text: Get v1 section stats for requirement {requirementId} of standard {complianceId}, {timeType} time, last {timeAmount} {timeUnit}.
        slots:
          requirementId: path.requirementId
          complianceId: path.complianceId
          timeType: query.timeType
          timeAmount: query.timeAmount
          timeUnit: query.timeUnit
      - text: Show v1 results for section {section} in requirement {requirementId} of standard {complianceId} over {timeAmount} {timeUnit} ({timeType}).
        slots:
          section: query.policy.complianceSection
          requirementId: path.requirementId
          complianceId: path.complianceId
          timeAmount: query.timeAmount
          timeUnit: query.timeUnit
          timeType: query.timeType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compliance/posture/{complianceId}/{requirementId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Query v1 requirement compliance stats by POST
      effect: read
      questions:
      - Is there a POST endpoint for the old per-requirement compliance breakdown that accepts body filters?
      - Can I sort or page the v1 section results for one compliance requirement?
      instructions:
      - text: POST a v1 stats request for requirement {requirementId} in standard {complianceId} with time range {timeRange}.
        slots:
          requirementId: path.requirementId
          complianceId: path.complianceId
          timeRange: requestBody.timeRange
      - text: Get the v1 per-requirement breakdown for {requirementId} under {complianceId}, sorted by {sortBy}, via POST.
        slots:
          requirementId: path.requirementId
          complianceId: path.complianceId
          sortBy: requestBody.sortBy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compliance/posture/trend'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the v1 compliance trend over time
      effect: read
      questions:
      - How has my overall pass/fail compliance trended over the past month in the v1 API?
      - Can I see the legacy compliance trend for just one cloud region?
      instructions:
      - text: Show the v1 compliance trend across all standards for the last {timeAmount} {timeUnit} ({timeType}).
        slots:
          timeAmount: query.timeAmount
          timeUnit: query.timeUnit
          timeType: query.timeType
      - text: Get the v1 compliance trend in region {region}, {timeType} time, {timeAmount} {timeUnit}.
        slots:
          region: query.cloud.region
          timeType: query.timeType
          timeAmount: query.timeAmount
          timeUnit: query.timeUnit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compliance/posture/trend'].post
  update:
    x-apievangelist-phrasing:
      intent: Query the v1 compliance trend by POST
      effect: read
      questions:
      - Can I request the old overall compliance trend with filters and a time range in a POST body?
      - Which legacy POST call returns the pass/fail trend summary for all standards?
      instructions:
      - text: POST a v1 overall compliance trend request covering time range {timeRange}.
        slots:
          timeRange: requestBody.timeRange
      - text: Get the v1 all-standards compliance trend filtered by {filters} using POST.
        slots:
          filters: requestBody.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compliance/posture/trend/{complianceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the v1 compliance trend for one standard
      effect: read
      questions:
      - Is my score on one compliance standard improving over time according to the v1 trend endpoint?
      - Can I view the legacy trend for a single standard restricted to one cloud account?
      instructions:
      - text: Show the v1 compliance trend for standard {complianceId} over the last {timeAmount} {timeUnit} ({timeType}).
        slots:
          complianceId: path.complianceId
          timeAmount: query.timeAmount
          timeUnit: query.timeUnit
          timeType: query.timeType
      - text: Get the v1 trend for standard {complianceId} in account {account}, {timeType} time, {timeAmount} {timeUnit}.
        slots:
          complianceId: path.complianceId
          account: query.cloud.account
          timeType: query.timeType
          timeAmount: query.timeAmount
          timeUnit: query.timeUnit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compliance/posture/trend/{complianceId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Query the v1 trend for a standard by POST
      effect: read
      questions:
      - Can I pass a time range in the body when pulling one standard's trend from the older API?
      - Which POST endpoint gives the v1 pass/fail trend for a given compliance standard ID?
      instructions:
      - text: POST a v1 trend request for standard {complianceId} with time range {timeRange}.
        slots:
          complianceId: path.complianceId
          timeRange: requestBody.timeRange
      - text: Get the v1 trend for standard {complianceId} with body filters {filters}.
        slots:
          complianceId: path.complianceId
          filters: requestBody.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compliance/posture/trend/{complianceId}/{requirementId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the v1 compliance trend for a requirement
      effect: read
      questions:
      - How has a single compliance requirement's pass/fail trend moved over the last few weeks in the v1 API?
      - Can the legacy requirement trend be filtered to one section ID?
      instructions:
      - text: Show the v1 trend for requirement {requirementId} in standard {complianceId} for the last {timeAmount} {timeUnit} ({timeType}).
        slots:
          requirementId: path.requirementId
          complianceId: path.complianceId
          timeAmount: query.timeAmount
          timeUnit: query.timeUnit
          timeType: query.timeType
      - text: Get the v1 requirement trend for {requirementId} under {complianceId}, section {section}, {timeType} {timeAmount} {timeUnit}.
        slots:
          requirementId: path.requirementId
          complianceId: path.complianceId
          section: query.policy.complianceSection
          timeType: query.timeType
          timeAmount: query.timeAmount
          timeUnit: query.timeUnit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compliance/posture/trend/{complianceId}/{requirementId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Query the v1 requirement trend by POST
      effect: read
      questions:
      - Is there a legacy POST call for the trend of one requirement that takes a body time range?
      - Can I filter the v1 per-requirement trend with body filters instead of query parameters?
      instructions:
      - text: POST a v1 trend request for requirement {requirementId} of standard {complianceId} over {timeRange}.
        slots:
          requirementId: path.requirementId
          complianceId: path.complianceId
          timeRange: requestBody.timeRange
      - text: Get the v1 requirement trend for {requirementId} in {complianceId} filtered by {filters} via POST.
        slots:
          requirementId: path.requirementId
          complianceId: path.complianceId
          filters: requestBody.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filter/compliance/posture/suggest'].get
  update:
    x-apievangelist-phrasing:
      intent: List compliance overview filters and options
      effect: read
      questions:
      - What filters can I apply to compliance posture data, and what saved options exist for each?
      - Which filter keys does the compliance overview support?
      instructions:
      - text: List all compliance posture filter keys with their available and saved options.
      - text: Show me the filters supported on the compliance overview.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filter/compliance/posture/suggest'].post
  update:
    x-apievangelist-phrasing:
      intent: Autocomplete values for a compliance filter
      effect: read
      questions:
      - What values can I pick for a specific compliance posture filter?
      - Can I fuzzy-search the options of one compliance overview filter by typing part of a value?
      instructions:
      - text: Suggest values for compliance filter {filterName}.
        slots:
          filterName: requestBody.filterName
      - text: Autocomplete compliance filter {filterName} for options containing {query}.
        slots:
          filterName: requestBody.filterName
          query: requestBody.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/compliance/posture'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the V2 compliance breakdown for all standards
      effect: read
      questions:
      - How do I get a current pass/fail summary across every compliance standard with the V2 API?
      - Can I filter the V2 all-standards compliance breakdown by cloud type or account?
      instructions:
      - text: Get the V2 compliance statistics breakdown across all standards.
      - text: Show the V2 all-standards compliance breakdown for cloud account {account}.
        slots:
          account: query.cloud.account
      - text: Get V2 compliance stats for standard name {standard} across my clouds.
        slots:
          standard: query.policy.complianceStandard
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/compliance/posture'].post
  update:
    x-apievangelist-phrasing:
      intent: Query the V2 all-standards breakdown by POST
      effect: read
      questions:
      - Can I use body filters and pick fields when requesting the V2 compliance breakdown across all standards?
      - Which V2 POST call summarizes pass/fail results for every compliance standard?
      instructions:
      - text: POST a V2 all-standards compliance breakdown request with filters {filters}.
        slots:
          filters: requestBody.filters
      - text: Return only fields {fields} in the V2 all-standards compliance breakdown.
        slots:
          fields: requestBody.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/compliance/posture/{complianceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get V2 compliance stats for one standard
      effect: read
      questions:
      - How is one compliance standard doing right now according to the V2 statistics endpoint?
      - Can I scope the V2 standard breakdown to a single requirement name?
      instructions:
      - text: Get the V2 pass/fail breakdown for compliance standard {complianceId}.
        slots:
          complianceId: path.complianceId
      - text: Show V2 stats for standard {complianceId} limited to requirement {requirement}.
        slots:
          complianceId: path.complianceId
          requirement: query.policy.complianceRequirement
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/compliance/posture/{complianceId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Query V2 stats for a standard by POST
      effect: read
      questions:
      - Can I request specific fields when POSTing for one standard's V2 compliance statistics?
      - Which V2 POST call returns the breakdown for a given compliance standard ID with body filters?
      instructions:
      - text: POST a V2 statistics request for standard {complianceId} with filters {filters}.
        slots:
          complianceId: path.complianceId
          filters: requestBody.filters
      - text: Get V2 stats for standard {complianceId} returning only {fields}.
        slots:
          complianceId: path.complianceId
          fields: requestBody.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/compliance/posture/{complianceId}/{requirementId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get V2 compliance stats for one requirement
      effect: read
      questions:
      - What are the section-level pass/fail results for a single requirement in the V2 API?
      - Can I narrow the V2 requirement breakdown to one cloud region?
      instructions:
      - text: Get V2 section stats for requirement {requirementId} of standard {complianceId}.
        slots:
          requirementId: path.requirementId
          complianceId: path.complianceId
      - text: Show V2 results for requirement {requirementId} in {complianceId} for region {region}.
        slots:
          requirementId: path.requirementId
          complianceId: path.complianceId
          region: query.cloud.region
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/compliance/posture/{complianceId}/{requirementId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Query V2 requirement stats by POST
      effect: read
      questions:
      - Is there a V2 POST endpoint for one requirement's section breakdown that accepts filters in the body?
      - Can I page through the V2 per-requirement compliance results?
      instructions:
      - text: POST a V2 stats request for requirement {requirementId} in standard {complianceId} with filters {filters}.
        slots:
          requirementId: path.requirementId
          complianceId: path.complianceId
          filters: requestBody.filters
      - text: Get the next {limit} V2 section results for requirement {requirementId} of {complianceId}.
        slots:
          limit: requestBody.limit
          requirementId: path.requirementId
          complianceId: path.complianceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/compliance/posture/trend'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the V2 compliance trend for all standards
      effect: read
      questions:
      - Is my overall compliance getting better or worse over time according to the V2 trend?
      - Can I see the V2 compliance trend for just one cloud type?
      instructions:
      - text: Show the V2 overall compliance pass/fail trend.
      - text: Get the V2 compliance trend for cloud type {cloudType}.
        slots:
          cloudType: query.cloud.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/compliance/posture/trend'].post
  update:
    x-apievangelist-phrasing:
      intent: Query the V2 overall trend by POST
      effect: read
      questions:
      - Can I send a time range and filters in the body to get the V2 all-standards compliance trend?
      - Which V2 POST call returns the trend summary across every standard?
      instructions:
      - text: POST a V2 all-standards trend request over time range {timeRange}.
        slots:
          timeRange: requestBody.timeRange
      - text: Get the V2 overall compliance trend filtered by {filters} using POST.
        slots:
          filters: requestBody.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/compliance/posture/trend/{complianceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the V2 trend for one standard
      effect: read
      questions:
      - How has a particular compliance standard trended in the V2 API?
      - Can I filter one standard's V2 trend to a single cloud account?
      instructions:
      - text: Show the V2 pass/fail trend for standard {complianceId}.
        slots:
          complianceId: path.complianceId
      - text: Get the V2 trend for standard {complianceId} in cloud account {account}.
        slots:
          complianceId: path.complianceId
          account: query.cloud.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/compliance/posture/trend/{complianceId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Query the V2 standard trend by POST
      effect: read
      questions:
      - Is there a V2 POST version of the per-standard compliance trend that takes body filters?
      - Can I choose the returned fields for one standard's V2 trend?
      instructions:
      - text: POST a V2 trend request for standard {complianceId} with filters {filters}.
        slots:
          complianceId: path.complianceId
          filters: requestBody.filters
      - text: Get the V2 trend for standard {complianceId} returning fields {fields}.
        slots:
          complianceId: path.complianceId
          fields: requestBody.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/compliance/posture/trend/{complianceId}/{requirementId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the V2 trend for one requirement
      effect: read
      questions:
      - How has one compliance requirement trended over time in the V2 API?
      - Can the V2 requirement trend be filtered to a single section?
      instructions:
      - text: Show the V2 trend for requirement {requirementId} in standard {complianceId}.
        slots:
          requirementId: path.requirementId
          complianceId: path.complianceId
      - text: Get the V2 trend of section {section} under requirement {requirementId} of {complianceId}.
        slots:
          section: query.policy.complianceSection
          requirementId: path.requirementId
          complianceId: path.complianceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/compliance/posture/trend/{complianceId}/{requirementId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Query the V2 requirement trend by POST
      effect: read
      questions:
      - Is there a V2 POST call for one requirement's trend that accepts filters in the body?
      - Can I sort the V2 per-requirement trend results?
      instructions:
      - text: POST a V2 trend request for requirement {requirementId} of standard {complianceId} filtered by {filters}.
        slots:
          requirementId: path.requirementId
          complianceId: path.complianceId
          filters: requestBody.filters
      - text: Get the V2 requirement trend for {requirementId} in {complianceId} sorted by {sortBy}.
        slots:
          requirementId: path.requirementId
          complianceId: path.complianceId
          sortBy: requestBody.sortBy
      method: generated
      generated: '2026-09-26'