Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Device Settings Service Settings API

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

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

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

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

$.paths['/service-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 Service Settings API
  version: 1.0.0
extends: openapi/palo-alto-networks-service-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['/service-settings'].get
  update:
    x-apievangelist-phrasing:
      intent: List service settings
      effect: read
      questions:
      - What device service settings are configured, like DNS and NTP servers?
      - Can I see service settings for a single device?
      instructions:
      - text: List service settings for device {device}.
        slots:
          device: query.device
      - text: Show service settings in folder {folder}.
        slots:
          folder: query.folder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/service-settings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create service settings
      effect: write
      questions:
      - How do I define new device service settings?
      - Can I create a service settings object through the API?
      instructions:
      - text: Create service settings with services {services}.
        slots:
          services: requestBody.services
      - text: Add a new device service settings object.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/service-settings/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get service settings
      effect: read
      questions:
      - What does one service settings object contain?
      - Can I retrieve service settings by UUID?
      instructions:
      - text: Get service settings {id}.
        slots:
          id: path.id
      - text: Show the services configured in settings object {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/service-settings/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update service settings
      effect: write
      questions:
      - How do I change existing device service settings?
      - Can I update the services in a settings object I already made?
      instructions:
      - text: Update service settings {id} with services {services}.
        slots:
          id: path.id
          services: requestBody.services
      - text: Modify service settings object {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/service-settings/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete service settings
      effect: destructive
      questions:
      - How do I delete a service settings object?
      - Is removing service settings permanent?
      instructions:
      - text: Delete service settings {id}.
        slots:
          id: path.id
      - text: Remove the service settings with UUID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'