# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Configuration Setup Snippet Snapshots API
  version: 1.0.0
extends: openapi/palo-alto-networks-snippet-snapshots-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['/snippet-snapshots'].post
  update:
    x-apievangelist-phrasing:
      intent: Save a snapshot of a snippet
      effect: write
      questions:
      - Can I save the current state of a configuration snippet as a snapshot?
      - Is a description required when saving a snippet snapshot?
      instructions:
      - text: Save a snapshot of snippet {id} described as {description}.
        slots:
          id: requestBody.id
          description: requestBody.description
      - text: Take a snapshot of snippet {id} with note {description}.
        slots:
          id: requestBody.id
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/snippet-snapshots:publish'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a snippet snapshot to tenants
      effect: write
      questions:
      - How do I push a snippet snapshot out to other tenant service groups?
      - Can I validate a snippet snapshot while publishing it?
      instructions:
      - text: Publish version {version} of snippet {id} to tenants {tsgs}.
        slots:
          version: requestBody.version
          id: requestBody.id
          tsgs: requestBody.tsgs
      - text: Publish snippet snapshot {name} with validation {validation}.
        slots:
          name: requestBody.name
          validation: requestBody.validation
      method: generated
      generated: '2026-09-26'
- target: $.paths['/snippet-snapshots:compare'].post
  update:
    x-apievangelist-phrasing:
      intent: Compare two versions of a snippet
      effect: read
      questions:
      - What changed in a snippet between two snapshot versions?
      - Can I compare the whole snippet at version 3 against version 5?
      instructions:
      - text: Compare snippet {id} version {version} with version {comparing_version}.
        slots:
          id: requestBody.id
          version: requestBody.version
          comparing_version: requestBody.comparing_version
      - text: Show the differences across snippet {id} between snapshots {version} and {comparing_version}.
        slots:
          id: requestBody.id
          version: requestBody.version
          comparing_version: requestBody.comparing_version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/snippet-snapshots:diff'].post
  update:
    x-apievangelist-phrasing:
      intent: Diff one object inside a snippet across versions
      effect: read
      questions:
      - How did a single object inside a snippet change between snapshot versions?
      - Can I diff just one configuration object rather than the whole snippet?
      instructions:
      - text: Diff object {object_id} in snippet {snippet_id} at version {version}.
        slots:
          object_id: requestBody.object_id
          snippet_id: requestBody.snippet_id
          version: requestBody.version
      - text: Diff object {object_id} of snippet {snippet_id} between versions {version} and {comparing_version}.
        slots:
          object_id: requestBody.object_id
          snippet_id: requestBody.snippet_id
          version: requestBody.version
          comparing_version: requestBody.comparing_version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/snippet-snapshots:load'].post
  update:
    x-apievangelist-phrasing:
      intent: Load (roll back to) a snippet snapshot
      effect: write
      questions:
      - Can I roll a snippet back to an earlier saved snapshot?
      - What's the way to restore a snippet from a specific version?
      instructions:
      - text: Load snapshot version {version} into snippet {id}.
        slots:
          version: requestBody.version
          id: requestBody.id
      - text: Roll snippet {id} back to version {version}.
        slots:
          id: requestBody.id
          version: requestBody.version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/snippet-snapshots:updates'].post
  update:
    x-apievangelist-phrasing:
      intent: Pull snippet snapshot updates for a tenant
      effect: write
      questions:
      - Can I apply the latest snapshot updates of a snippet to a particular tenant?
      - What do I pass to update a snippet snapshot for one tenant?
      instructions:
      - text: Apply snapshot updates of snippet {id} to tenant {tenant_id}.
        slots:
          id: requestBody.id
          tenant_id: requestBody.tenant_id
      - text: Update tenant {tenant_id} to the latest snapshot of snippet {id}.
        slots:
          tenant_id: requestBody.tenant_id
          id: requestBody.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/snippet-snapshots:convert'].post
  update:
    x-apievangelist-phrasing:
      intent: Convert a snippet snapshot
      effect: write
      questions:
      - Can I convert a snippet snapshot and keep a local copy?
      - What does the keep_local option do when converting a snippet snapshot?
      instructions:
      - text: Convert snippet snapshot {id}.
        slots:
          id: requestBody.id
      - text: Convert snippet {id} with keep-local set to {keep_local}.
        slots:
          id: requestBody.id
          keep_local: requestBody.keep_local
      method: generated
      generated: '2026-09-26'