Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Objects Device Context Segments API

7 actions 7 updates phrasing extends openapi/palo-alto-networks-device-context-segments-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 7

$.info
$.paths['/device-context-segments'].get
$.paths['/device-context-segments'].post
$.paths['/device-context-segments'].delete
$.paths['/device-context-segments/{id}'].get
$.paths['/device-context-segments/{id}'].put
$.paths['/device-context-segments/{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 Device Context Segments API
  version: 1.0.0
extends: openapi/palo-alto-networks-device-context-segments-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: 6
- target: $.paths['/device-context-segments'].get
  update:
    x-apievangelist-phrasing:
      intent: List device context segments
      effect: read
      questions:
      - Which device context segments are configured?
      - Can I search device context segments by name?
      instructions:
      - text: List device context segments.
      - text: Find device context segments named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/device-context-segments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a device context segment
      effect: write
      questions:
      - How do I add a new device context segment?
      - Can I give a device context segment a description when creating it?
      instructions:
      - text: Create device context segment {name}.
        slots:
          name: requestBody.name
      - text: Add device context segment {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/device-context-segments'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete device context segments by name
      effect: destructive
      questions:
      - Can I delete several device context segments by name at once?
      - Is there a way to remove a segment without knowing its UUID?
      instructions:
      - text: Delete device context segments named {name}.
        slots:
          name: query.name
      - text: Remove the segments called {name} by name.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/device-context-segments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a device context segment
      effect: read
      questions:
      - What's configured in one device context segment?
      - Can I fetch a device context segment by UUID?
      instructions:
      - text: Get device context segment {id}.
        slots:
          id: path.id
      - text: Show segment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/device-context-segments/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a device context segment
      effect: write
      questions:
      - Can I rename an existing device context segment?
      - Is it possible to change a segment's description?
      instructions:
      - text: Rename device context segment {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Update segment {id} description to {description}, keeping name {name}.
        slots:
          id: path.id
          description: requestBody.description
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/device-context-segments/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a device context segment by ID
      effect: destructive
      questions:
      - How do I remove a single device context segment by its UUID?
      - What's the call to delete one segment by ID?
      instructions:
      - text: Delete device context segment {id}.
        slots:
          id: path.id
      - text: Remove segment with UUID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'