Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Objects HTTP Server Profiles API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-http-server-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 6

$.info
$.paths['/http-server-profiles'].get
$.paths['/http-server-profiles'].post
$.paths['/http-server-profiles/{id}'].get
$.paths['/http-server-profiles/{id}'].put
$.paths['/http-server-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 Objects HTTP Server Profiles API
  version: 1.0.0
extends: openapi/palo-alto-networks-http-server-profiles-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: 5
- target: $.paths['/http-server-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List HTTP server profiles
      effect: read
      questions:
      - Which HTTP server profiles are set up for log forwarding?
      - Can I list HTTP server profiles in a specific folder or snippet?
      instructions:
      - text: List HTTP server profiles in folder {folder}.
        slots:
          folder: query.folder
      - text: Find the HTTP server profile named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/http-server-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an HTTP server profile
      effect: write
      questions:
      - How do I add an HTTP server profile to send logs to a web endpoint?
      - Can I set the payload format when creating an HTTP server profile?
      instructions:
      - text: Create HTTP server profile {name} with ID {id}.
        slots:
          name: requestBody.name
          id: requestBody.id
      - text: Add an HTTP server profile {name} (ID {id}) pointing at servers {server}.
        slots:
          name: requestBody.name
          id: requestBody.id
          server: requestBody.server
      method: generated
      generated: '2026-09-26'
- target: $.paths['/http-server-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an HTTP server profile
      effect: read
      questions:
      - What servers and format does a given HTTP server profile use?
      - Can I fetch one HTTP server profile by ID?
      instructions:
      - text: Show HTTP server profile {id}.
        slots:
          id: path.id
      - text: Get the server list configured in HTTP profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/http-server-profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an HTTP server profile
      effect: write
      questions:
      - Can I change the destination servers on an existing HTTP server profile?
      - How do I turn on tag registration for an HTTP server profile I already made?
      instructions:
      - text: Update HTTP server profile {id} named {name} to use servers {server}.
        slots:
          id: path.id
          name: requestBody.name
          server: requestBody.server
      - text: Change the log format of existing HTTP profile {id} ({name}) to {format}.
        slots:
          id: path.id
          name: requestBody.name
          format: requestBody.format
      method: generated
      generated: '2026-09-26'
- target: $.paths['/http-server-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an HTTP server profile
      effect: destructive
      questions:
      - Can I delete an HTTP server profile that's no longer used?
      - What removes an HTTP log forwarding profile?
      instructions:
      - text: Delete HTTP server profile {id}.
        slots:
          id: path.id
      - text: Remove the HTTP log forwarding profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'