# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for LXD external REST Replicators API
  version: 1.0.0
extends: openapi/canonical-replicators-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: 10
- target: $.paths['/1.0/replicators'].get
  update:
    x-apievangelist-phrasing:
      intent: List replicators as URLs
      effect: read
      questions:
      - Which replicators are configured on my LXD cluster?
      - Can I list replicator URLs across every project?
      instructions:
      - text: List the URLs of my replicators.
      - text: List replicator URLs in project {project}.
        slots:
          project: query.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1.0/replicators'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a replicator
      effect: write
      questions:
      - How do I set up a new replicator for a project?
      - Can I give a replicator config and a description when creating it?
      instructions:
      - text: Create replicator {name}.
        slots:
          name: requestBody.name
      - text: Add replicator {name} with config {config} in project {project}.
        slots:
          name: requestBody.name
          config: requestBody.config
          project: query.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1.0/replicators/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a replicator
      effect: read
      questions:
      - What configuration does a particular replicator have?
      - Where can I read one replicator's settings?
      instructions:
      - text: Show this replicator's configuration.
      - text: Get the replicator details in project {project}.
        slots:
          project: query.project
      - text: Show the configuration of replicator {replicator}.
        slots:
          replicator: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/replicators/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a replicator's configuration
      effect: write
      questions:
      - How do I overwrite a replicator's full configuration?
      - Will replacing a replicator's config drop keys I omit?
      instructions:
      - text: Replace the replicator config with {config}.
        slots:
          config: requestBody.config
      - text: Overwrite the replicator config {config} and description {description}.
        slots:
          config: requestBody.config
          description: requestBody.description
      - text: Replace the entire config of replicator {replicator} with {config}.
        slots:
          replicator: path.name
          config: requestBody.config
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/replicators/{name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename a replicator
      effect: write
      questions:
      - Is it possible to rename an existing replicator?
      - Can I change a replicator's name without recreating it?
      instructions:
      - text: Rename the replicator to {name}.
        slots:
          name: requestBody.name
      - text: Give the replicator in project {project} the new name {name}.
        slots:
          project: query.project
          name: requestBody.name
      - text: Rename replicator {replicator} to {name}.
        slots:
          replicator: path.name
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/replicators/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a replicator
      effect: destructive
      questions:
      - How do I remove a replicator I no longer need?
      - Can I delete a replicator from a specific project?
      instructions:
      - text: Delete this replicator.
      - text: Remove the replicator from project {project}.
        slots:
          project: query.project
      - text: Delete replicator {replicator}.
        slots:
          replicator: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/replicators/{name}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a replicator
      effect: write
      questions:
      - Can I change just the description of a replicator?
      - How do I update one replicator config key without resending everything?
      instructions:
      - text: Patch the replicator description to {description}.
        slots:
          description: requestBody.description
      - text: Merge config keys {config} into the replicator's settings.
        slots:
          config: requestBody.config
      - text: Patch replicator {replicator}, changing only its description to {description}.
        slots:
          replicator: path.name
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/replicators/{name}/state'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a replicator's current state
      effect: read
      questions:
      - Is my replicator currently running, and what did its last run do?
      - What state is a given replicator in?
      instructions:
      - text: Show the current state of this replicator.
      - text: Check the replicator run state in project {project}.
        slots:
          project: query.project
      - text: Check whether replicator {replicator} is running or idle.
        slots:
          replicator: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/replicators/{name}/state'].put
  update:
    x-apievangelist-phrasing:
      intent: Trigger a replicator run or restore
      effect: write
      questions:
      - How do I kick off a replicator run on demand?
      - Why does a replicator restore fail when instances are still running?
      instructions:
      - text: Trigger the replicator with action {action}.
        slots:
          action: requestBody.action
      - text: Run a restore from the replicator in project {project} after instances are stopped.
        slots:
          project: query.project
      - text: Run action {action} on replicator {replicator}.
        slots:
          replicator: path.name
          action: requestBody.action
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/replicators?recursion=1'].get
  update:
    x-apievangelist-phrasing:
      intent: List replicators with full details
      effect: read
      questions:
      - How do I get every replicator with its config in one call?
      - Can I see full replicator objects across all projects?
      instructions:
      - text: List all replicators as full objects with config.
      - text: Get expanded replicators for project {project}.
        slots:
          project: query.project
      method: generated
      generated: '2026-09-26'