Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Security Services HTTP Header Profiles API

11 actions 11 updates phrasing extends openapi/palo-alto-networks-http-header-profiles-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['/http-header-profiles'].get
$.paths['/http-header-profiles'].post
$.paths['/http-header-profiles/{id}'].get
$.paths['/http-header-profiles/{id}'].put
$.paths['/http-header-profiles/{id}'].delete
$.paths['/sse/config/v1/http-header-profiles'].get
$.paths['/sse/config/v1/http-header-profiles'].post
$.paths['/sse/config/v1/http-header-profiles/{id}'].get
$.paths['/sse/config/v1/http-header-profiles/{id}'].put
$.paths['/sse/config/v1/http-header-profiles/{id}'].delete

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 Security Services HTTP Header Profiles API
  version: 1.0.0
extends: openapi/palo-alto-networks-http-header-profiles-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 10
- target: $.paths['/http-header-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List HTTP header profiles
      effect: read
      questions:
      - Which HTTP header profiles are configured in my Strata Cloud Manager tenant?
      - Can I list HTTP header profiles from just one folder, snippet or device?
      instructions:
      - text: List all HTTP header profiles.
      - text: List HTTP header profiles in folder {folder}.
        slots:
          folder: query.folder
      - text: Find HTTP header profiles named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/http-header-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a HTTP header profile
      effect: write
      questions:
      - How do I create a new HTTP header profile?
      - Can a new HTTP header profile insert custom headers into web traffic?
      instructions:
      - text: Create a HTTP header profile named {name}.
        slots:
          name: requestBody.name
      - text: Add HTTP header profile {name} with description {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      - text: Create HTTP header profile {name} inserting headers {http_header_insertion}.
        slots:
          name: requestBody.name
          http_header_insertion: requestBody.http_header_insertion
      method: generated
      generated: '2026-09-26'
- target: $.paths['/http-header-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a HTTP header profile
      effect: read
      questions:
      - What settings does a specific HTTP header profile contain?
      - Can I fetch one HTTP header profile by its id?
      instructions:
      - text: Get HTTP header profile {id}.
        slots:
          id: path.id
      - text: Show the configuration of HTTP header profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/http-header-profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a HTTP header profile
      effect: write
      questions:
      - How do I change the headers an existing HTTP header profile inserts?
      - Can I rename an existing HTTP header profile?
      instructions:
      - text: Rename HTTP header profile {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Update the description of HTTP header profile {id} to {description}.
        slots:
          id: path.id
          description: requestBody.description
      - text: Set header insertion {http_header_insertion} on HTTP header profile {id}.
        slots:
          http_header_insertion: requestBody.http_header_insertion
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/http-header-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a HTTP header profile
      effect: destructive
      questions:
      - Which call removes a HTTP header profile I no longer use?
      - Is deleting a HTTP header profile permanent?
      instructions:
      - text: Delete HTTP header profile {id}.
        slots:
          id: path.id
      - text: Remove the HTTP header profile with id {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/http-header-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List HTTP header profiles
      effect: read
      questions:
      - Which HTTP header insertion profiles exist in a folder?
      - Can I find an HTTP header profile by name?
      instructions:
      - text: List the SSE config HTTP header profiles in folder {folder}.
        slots:
          folder: query.folder
      - text: Find HTTP header profile {name} in folder {folder}.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/http-header-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an HTTP header profile
      effect: write
      questions:
      - How do I create a profile that inserts custom HTTP headers?
      - Can I add header insertion rules when creating an HTTP header profile?
      instructions:
      - text: Create HTTP header profile {name} in folder {folder}.
        slots:
          name: requestBody.name
          folder: query.folder
      - text: Add HTTP header profile {name} in {folder} inserting headers {headers}.
        slots:
          name: requestBody.name
          folder: query.folder
          headers: requestBody.http_header_insertion
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/http-header-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an HTTP header profile
      effect: read
      questions:
      - How do I view a single HTTP header profile?
      - What headers does a specific header profile insert?
      instructions:
      - text: Fetch SSE config HTTP header profile {id}.
        slots:
          id: path.id
      - text: Show the header insertion rules of profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/http-header-profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit an HTTP header profile
      effect: write
      questions:
      - Can I change the headers inserted by an existing HTTP header profile?
      - How do I rename an HTTP header profile?
      instructions:
      - text: Edit SSE v1 HTTP header profile {id} so its name is {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Update header profile {id} ({name}) to insert {headers}.
        slots:
          id: path.id
          name: requestBody.name
          headers: requestBody.http_header_insertion
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/http-header-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an HTTP header profile
      effect: destructive
      questions:
      - How do I delete an HTTP header profile?
      - Can I remove a header insertion profile I no longer use?
      instructions:
      - text: Delete SSE config HTTP header profile {id}.
        slots:
          id: path.id
      - text: Remove header profile {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'