Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for v2 Endpoint Policies API

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

$.info
$.paths['/v2/api/endpoint-policies'].get
$.paths['/v2/api/endpoint-policies'].post
$.paths['/v2/api/endpoint-policies/{resourceId}'].get
$.paths['/v2/api/endpoint-policies/{resourceId}'].put
$.paths['/v2/api/endpoint-policies/{resourceId}'].delete
$.paths['/v2/api/endpoint-policies/{resourceId}'].patch

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 v2 Endpoint Policies API
  version: 1.0.0
extends: openapi/palo-alto-networks-endpoint-policies-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: 6
- target: $.paths['/v2/api/endpoint-policies'].get
  update:
    x-apievangelist-phrasing:
      intent: List endpoint policies
      effect: read
      questions:
      - What endpoint policies does my tenant have?
      - Can I list only the endpoint policies that are currently enabled?
      instructions:
      - text: List endpoint policies where enabled is {enabled}.
        slots:
          enabled: query.enabled
      - text: Show page {page} of endpoint policies sorted by {sort}.
        slots:
          page: query.page
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api/endpoint-policies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an endpoint policy
      effect: write
      questions:
      - How do I create a new endpoint policy with a severity and a response action?
      - Which fields are required to define an endpoint policy's scope and type?
      instructions:
      - text: Create endpoint policy {name} of type {type} with severity {severity}, response {response}, scope {scope}, enabled {enabled}.
        slots:
          name: requestBody.name
          type: requestBody.type
          severity: requestBody.severity
          response: requestBody.response
          scope: requestBody.scope
          enabled: requestBody.enabled
      - text: Add a {type} endpoint policy named {name} at priority {priority}, severity {severity}, response {response}, scope {scope}, enabled {enabled}.
        slots:
          type: requestBody.type
          name: requestBody.name
          priority: requestBody.priority
          severity: requestBody.severity
          response: requestBody.response
          scope: requestBody.scope
          enabled: requestBody.enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api/endpoint-policies/{resourceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an endpoint policy
      effect: read
      questions:
      - Where can I see a single endpoint policy's configuration?
      - What classifiers and response does one endpoint policy use?
      instructions:
      - text: Get endpoint policy {resourceId}.
        slots:
          resourceId: path.resourceId
      - text: Show the scope and severity of endpoint policy {resourceId}.
        slots:
          resourceId: path.resourceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api/endpoint-policies/{resourceId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an endpoint policy in full
      effect: write
      questions:
      - How do I overwrite an entire endpoint policy with a new definition?
      - Does a full endpoint policy replace require every field again?
      instructions:
      - text: Replace endpoint policy {resourceId} with name {name}, type {type}, severity {severity}, response {response}, scope {scope}, enabled {enabled}.
        slots:
          resourceId: path.resourceId
          name: requestBody.name
          type: requestBody.type
          severity: requestBody.severity
          response: requestBody.response
          scope: requestBody.scope
          enabled: requestBody.enabled
      - text: Fully rewrite endpoint policy {resourceId} using classifiers {classifiers}.
        slots:
          resourceId: path.resourceId
          classifiers: requestBody.classifiers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api/endpoint-policies/{resourceId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an endpoint policy
      effect: destructive
      questions:
      - Can I delete an endpoint policy I no longer need?
      - Is an endpoint policy removed by its resource ID?
      instructions:
      - text: Delete endpoint policy {resourceId}.
        slots:
          resourceId: path.resourceId
      - text: Remove endpoint policy {resourceId} from my tenant.
        slots:
          resourceId: path.resourceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api/endpoint-policies/{resourceId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update an endpoint policy
      effect: write
      questions:
      - Can I change just one field of an endpoint policy with a merge patch?
      - How do I turn off an endpoint policy without rewriting the whole thing?
      instructions:
      - text: Patch endpoint policy {resourceId} to set enabled to {enabled}.
        slots:
          resourceId: path.resourceId
          enabled: requestBody.enabled
      - text: Merge-patch endpoint policy {resourceId} with priority {priority}.
        slots:
          resourceId: path.resourceId
          priority: requestBody.priority
      method: generated
      generated: '2026-09-26'