# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for v2 Data Patterns API
  version: 1.0.0
extends: openapi/palo-alto-networks-data-patterns-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 8
- target: $.paths['/v2/api/data-patterns'].get
  update:
    x-apievangelist-phrasing:
      intent: List data patterns
      effect: read
      questions:
      - Which DLP data patterns exist in my tenant?
      - Can I page and sort through my data patterns?
      instructions:
      - text: List my data patterns.
      - text: Show page {page} of data patterns, {size} per page, sorted by {sort}.
        slots:
          page: query.page
          size: query.size
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api/data-patterns'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom data pattern
      effect: write
      questions:
      - How do I define a custom data pattern to detect our internal ID numbers?
      - What detection config does a new data pattern need?
      instructions:
      - text: Create a {type} data pattern named {name} with detection config {detection_config}.
        slots:
          type: requestBody.type
          name: requestBody.name
          detection_config: requestBody.detection_config
      - text: Add a custom data pattern {name} of type {type} using matching rules {matching_rules}.
        slots:
          name: requestBody.name
          type: requestBody.type
          matching_rules: requestBody.matching_rules
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api/data-patterns/{resourceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a data pattern
      effect: read
      questions:
      - What matching rules does a specific data pattern use?
      - Can I retrieve one data pattern by its ID?
      instructions:
      - text: Get data pattern {resourceId}.
        slots:
          resourceId: path.resourceId
      - text: Show the matching rules of data pattern {resourceId}.
        slots:
          resourceId: path.resourceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api/data-patterns/{resourceId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a data pattern
      effect: write
      questions:
      - How do I fully overwrite an existing data pattern's definition?
      - Does replacing a data pattern require resending every field?
      instructions:
      - text: Replace data pattern {resourceId} with name {name}, type {type} and detection config {detection_config}.
        slots:
          resourceId: path.resourceId
          name: requestBody.name
          type: requestBody.type
          detection_config: requestBody.detection_config
      - text: Overwrite data pattern {resourceId} entirely, setting name {name}, type {type}, detection {detection_config} and rules {matching_rules}.
        slots:
          resourceId: path.resourceId
          name: requestBody.name
          type: requestBody.type
          detection_config: requestBody.detection_config
          matching_rules: requestBody.matching_rules
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api/data-patterns/{resourceId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Archive a data pattern
      effect: destructive
      questions:
      - Is deleting a data pattern permanent or does it archive it?
      - Can I retire a data pattern we no longer use?
      instructions:
      - text: Archive data pattern {resourceId}.
        slots:
          resourceId: path.resourceId
      - text: Soft-delete data pattern {resourceId}.
        slots:
          resourceId: path.resourceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api/data-patterns/{resourceId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a data pattern
      effect: write
      questions:
      - Can I change just the description or tags of a data pattern without resending it all?
      - Does patching a data pattern use merge-patch semantics?
      instructions:
      - text: Patch data pattern {resourceId} to set tags {tags}.
        slots:
          resourceId: path.resourceId
          tags: requestBody.tags
      - text: Merge a new description {description} into data pattern {resourceId}.
        slots:
          resourceId: path.resourceId
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data-patterns'].get
  update:
    x-apievangelist-phrasing:
      intent: List DLP data patterns
      effect: read
      questions:
      - Which DLP data patterns are available, like credit card or social security number detectors?
      - Can I page through both predefined and custom data patterns?
      instructions:
      - text: List all DLP data patterns.
      - text: Show {limit} data patterns starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-patterns/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a DLP data pattern's detection rules
      effect: read
      questions:
      - What regular expressions and confidence settings does a specific data pattern use?
      - How does one DLP pattern detect matches, including its proximity keywords?
      instructions:
      - text: Get the regex, keyword and proximity settings of DLP data pattern {id}.
        slots:
          id: path.id
      - text: Show the detection rules and confidence scoring of data pattern {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'