Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Advanced Device Objects API

8 actions 8 updates phrasing extends openapi/palo-alto-networks-advanced-device-objects-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 8

$.info
$.paths['/advanced-device-objects'].get
$.paths['/advanced-device-objects'].put
$.paths['/advanced-device-objects'].post
$.paths['/advanced-device-objects'].delete
$.paths['/advanced-device-objects/{id}'].get
$.paths['/advanced-device-objects/{id}'].put
$.paths['/advanced-device-objects/{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 Advanced Device Objects API
  version: 1.0.0
extends: openapi/palo-alto-networks-advanced-device-objects-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: 7
- target: $.paths['/advanced-device-objects'].get
  update:
    x-apievangelist-phrasing:
      intent: List advanced device objects
      effect: read
      questions:
      - What advanced device objects exist in a folder or snippet?
      - Can I filter advanced device objects by name or device?
      instructions:
      - text: List advanced device objects in folder {folder}.
        slots:
          folder: query.folder
      - text: List advanced device objects on device {device}.
        slots:
          device: query.device
      method: generated
      generated: '2026-09-26'
- target: $.paths['/advanced-device-objects'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an advanced device object by name
      effect: write
      questions:
      - Can I update an advanced device object by name and folder instead of by ID?
      - Is there a way to edit an object when I only know its container path?
      instructions:
      - text: Update the advanced device object named {name} in folder {folder}.
        slots:
          name: query.name
          folder: query.folder
      - text: Change the description of object {name} in snippet {snippet} to {description}.
        slots:
          name: query.name
          snippet: query.snippet
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/advanced-device-objects'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an advanced device object
      effect: write
      questions:
      - How do I create a new advanced device object?
      - What fields are required for a new advanced device object?
      instructions:
      - text: Create an advanced device object named {name} with ID {id}.
        slots:
          name: requestBody.name
          id: requestBody.id
      - text: Add a new advanced device object {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/advanced-device-objects'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete advanced device objects by name
      effect: destructive
      questions:
      - Can I delete several advanced device objects by their names at once?
      - Is bulk deletion by name supported for advanced device objects?
      instructions:
      - text: Delete the advanced device objects named {name}.
        slots:
          name: query.name
      - text: Remove objects {name} from folder {folder} by name.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/advanced-device-objects/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an advanced device object
      effect: read
      questions:
      - How can I look up one advanced device object by its ID?
      - What does a single advanced device object contain?
      instructions:
      - text: Get advanced device object {id}.
        slots:
          id: path.id
      - text: Show the details of advanced device object with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/advanced-device-objects/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an advanced device object by ID
      effect: write
      questions:
      - Can I rename an advanced device object when I have its ID?
      - Which fields of an advanced device object can be changed by ID?
      instructions:
      - text: Rename advanced device object {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Update the description of object ID {id} to {description}.
        slots:
          id: path.id
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/advanced-device-objects/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an advanced device object by ID
      effect: destructive
      questions:
      - How do I delete one advanced device object using its ID?
      - Does deleting an advanced device object by ID remove it permanently?
      instructions:
      - text: Delete advanced device object {id}.
        slots:
          id: path.id
      - text: Remove the advanced device object with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'