Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Security Services Data Objects API

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

$.paths['/data-objects'].post

$.paths['/data-objects/{id}'].get

$.paths['/data-objects/{id}'].put

$.paths['/data-objects/{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 Security Services Data Objects API
  version: 1.0.0
extends: openapi/palo-alto-networks-dataobjects-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['/data-objects'].get
  update:
    x-apievangelist-phrasing:
      intent: List data objects
      effect: read
      questions:
      - Which data loss prevention data objects are defined?
      - Can I list data objects in a particular folder or snippet?
      instructions:
      - text: List the data objects in folder {folder}.
        slots:
          folder: query.folder
      - text: Find the data object named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data-objects'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a data object
      effect: write
      questions:
      - How do I define a new data object for data pattern matching?
      - Can I set a pattern type when creating a data object?
      instructions:
      - text: Create a data object named {name} with pattern type {pattern_type}.
        slots:
          name: requestBody.name
          pattern_type: requestBody.pattern_type
      - text: Add data object {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data-objects/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a data object
      effect: read
      questions:
      - What patterns does a specific data object contain?
      - Can I fetch a data object by its UUID?
      instructions:
      - text: Get data object {id}.
        slots:
          id: path.id
      - text: Show the configuration of data object {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data-objects/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a data object
      effect: write
      questions:
      - How do I change the pattern type of an existing data object?
      - Can I edit a data object's description?
      instructions:
      - text: Update data object {id} to use pattern type {pattern_type}.
        slots:
          id: path.id
          pattern_type: requestBody.pattern_type
      - text: Change the description of existing data object {id} to {description}.
        slots:
          id: path.id
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data-objects/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a data object
      effect: destructive
      questions:
      - How do I remove a data object I no longer need?
      - Can a data object be deleted by UUID?
      instructions:
      - text: Delete data object {id}.
        slots:
          id: path.id
      - text: Remove the data object with UUID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'