Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Configuration Orchestration IKE Gateway API

3 actions 3 updates phrasing extends openapi/palo-alto-networks-ike-gateway-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 3

$.info
$.paths['/v1/ike-gateways-read'].get
$.paths['/v1/ike-gateways-read'].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 Configuration Orchestration IKE Gateway API
  version: 1.0.0
extends: openapi/palo-alto-networks-ike-gateway-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: 2
- target: $.paths['/v1/ike-gateways-read'].get
  update:
    x-apievangelist-phrasing:
      intent: Get IKE gateway configs by UUID
      effect: read
      questions:
      - What IKE gateway configuration is tied to a given UUID?
      - Can I read remote network IKE gateways by ID rather than by name?
      instructions:
      - text: Get the IKE gateway configurations for UUID {id}.
        slots:
          id: query.id
      - text: Show IKE gateways associated with ID {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ike-gateways-read'].post
  update:
    x-apievangelist-phrasing:
      intent: Read IKE gateways by name
      effect: read
      questions:
      - Can I look up several remote network IKE gateways by their names at once?
      - Is it possible to read IKE gateways for a particular sub-tenant?
      instructions:
      - text: Read the IKE gateways named {names}.
        slots:
          names: requestBody.ike_gateways_names
      - text: Read IKE gateways {names} in sub-tenant {SubTenantName}.
        slots:
          names: requestBody.ike_gateways_names
          SubTenantName: query.SubTenantName
      method: generated
      generated: '2026-09-26'