Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Device Settings TCP Settings API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-tcp-settings-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['/tcp-settings'].get

$.paths['/tcp-settings'].post

$.paths['/tcp-settings/{id}'].get

$.paths['/tcp-settings/{id}'].put

$.paths['/tcp-settings/{id}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Device Settings TCP Settings API
  version: 1.0.0
extends: openapi/palo-alto-networks-tcp-settings-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['/tcp-settings'].get
  update:
    x-apievangelist-phrasing:
      intent: List TCP settings
      effect: read
      questions:
      - What TCP settings are configured for my firewalls?
      - Can I view TCP settings for one folder or device?
      instructions:
      - text: List TCP settings in folder {folder}.
        slots:
          folder: query.folder
      - text: Show TCP settings for device {device}.
        slots:
          device: query.device
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tcp-settings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create TCP settings
      effect: write
      questions:
      - How do I define new TCP session settings?
      - Can I create a TCP settings object with custom options?
      instructions:
      - text: Create TCP settings with options {tcp}.
        slots:
          tcp: requestBody.tcp
      - text: Add a new TCP settings object.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tcp-settings/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get TCP settings by ID
      effect: read
      questions:
      - What values does a specific TCP settings object hold?
      - Can I fetch TCP settings by ID?
      instructions:
      - text: Get TCP settings {id}.
        slots:
          id: path.id
      - text: Show the values in TCP settings object {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tcp-settings/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update TCP settings
      effect: write
      questions:
      - Can I change an existing TCP settings object?
      - How do I modify TCP options I already configured?
      instructions:
      - text: Update TCP settings {id} with options {tcp}.
        slots:
          id: path.id
          tcp: requestBody.tcp
      - text: Change the TCP options on settings object {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tcp-settings/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete TCP settings
      effect: destructive
      questions:
      - Can I remove a TCP settings object?
      - What do I need to delete TCP settings?
      instructions:
      - text: Delete TCP settings {id}.
        slots:
          id: path.id
      - text: Remove TCP settings object {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'