API Evangelist conversational phrasing for v2 Document Types API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for v2 Document Types API
  version: 1.0.0
extends: openapi/palo-alto-networks-document-types-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['/v2/api/document-types'].get
  update:
    x-apievangelist-phrasing:
      intent: List DLP document types
      effect: read
      questions:
      - Which custom document types has my tenant trained for data loss prevention?
      - Can I page and sort through my document types?
      instructions:
      - text: List my document types, {size} per page, sorted by {sort}.
        slots:
          size: query.size
          sort: query.sort
      - text: Show page {page} of the tenant's document types.
        slots:
          page: query.page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api/document-types'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a document type from training files
      effect: write
      questions:
      - How do I teach DLP a new document type by uploading example files?
      - Can I provide both positive and negative training samples for a document type?
      instructions:
      - text: Create a document type from definition {json} with positive samples {positive}.
        slots:
          json: requestBody.json
          positive: requestBody.positive
      - text: Upload training file {file} to create a new document type described by {json}, with negative samples {negative}.
        slots:
          file: requestBody.file
          json: requestBody.json
          negative: requestBody.negative
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api/document-types/{resourceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a document type
      effect: read
      questions:
      - What category and detection technique does a particular document type use?
      - How do I look up one document type by its ID?
      instructions:
      - text: Get document type {resourceId}.
        slots:
          resourceId: path.resourceId
      - text: Show the details of document type {resourceId}.
        slots:
          resourceId: path.resourceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api/document-types/{resourceId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a document type entirely
      effect: write
      questions:
      - Can I fully overwrite a document type's definition in one call?
      - What fields must I resend when replacing a document type wholesale?
      instructions:
      - text: Fully replace document type {resourceId} with name {name}, category {category} and technique {detection_technique}.
        slots:
          resourceId: path.resourceId
          name: requestBody.name
          category: requestBody.category
          detection_technique: requestBody.detection_technique
      - text: Overwrite document type {resourceId} using original file name {original_file_name}.
        slots:
          resourceId: path.resourceId
          original_file_name: requestBody.original_file_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api/document-types/{resourceId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a document type
      effect: destructive
      questions:
      - How do I remove a document type I no longer need?
      - Will deleting a document type stop it from being detected?
      instructions:
      - text: Delete document type {resourceId}.
        slots:
          resourceId: path.resourceId
      - text: Remove the document type with ID {resourceId}.
        slots:
          resourceId: path.resourceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api/document-types/{resourceId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a document type
      effect: write
      questions:
      - Can I change just the description of a document type without replacing it?
      - Does the document type API support merge-patch style edits?
      instructions:
      - text: Patch only the description of document type {resourceId} to {description}.
        slots:
          resourceId: path.resourceId
          description: requestBody.description
      - text: Merge-patch document type {resourceId} to move it to category {category}.
        slots:
          resourceId: path.resourceId
          category: requestBody.category
      method: generated
      generated: '2026-09-26'