# 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 Placement Groups API
  version: 1.0.0
extends: openapi/canonical-placement-groups-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['/1.0/placement-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List placement group URLs
      effect: read
      questions:
      - Which placement groups exist in my LXD project?
      - Can I list placement groups across all projects?
      instructions:
      - text: List the placement groups in project {project}.
        slots:
          project: query.project
      - text: Show placement groups across all projects ({all}).
        slots:
          all: query.all-projects
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1.0/placement-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a placement group
      effect: write
      questions:
      - How do I add a placement group to an LXD project?
      - Can I create a placement group in a specific project?
      instructions:
      - text: Create a placement group in project {project}.
        slots:
          project: query.project
      - text: Add a new placement group.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1.0/placement-groups/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a placement group
      effect: read
      questions:
      - What is configured on a specific placement group?
      - Can I view one placement group's settings?
      instructions:
      - text: Show placement group {name} in project {project}.
        slots:
          name: path.name
          project: query.project
      - text: Get one placement group's configuration.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/placement-groups/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a placement group
      effect: write
      questions:
      - How do I overwrite a placement group's full configuration?
      - Can I redefine an entire placement group in one call?
      instructions:
      - text: Replace the whole definition of placement group {name} in project {project}.
        slots:
          name: path.name
          project: query.project
      - text: Overwrite every setting of the placement group.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/placement-groups/{name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename a placement group
      effect: write
      questions:
      - Can I rename an existing placement group?
      - How do I give a placement group a different name?
      instructions:
      - text: Rename placement group {name} in project {project}.
        slots:
          name: path.name
          project: query.project
      - text: Give this placement group a new name.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/placement-groups/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a placement group
      effect: destructive
      questions:
      - How do I remove a placement group I no longer need?
      - Can a placement group be deleted from a given project?
      instructions:
      - text: Delete placement group {name} from project {project}.
        slots:
          name: path.name
          project: query.project
      - text: Remove this placement group.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/placement-groups/{name}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a placement group
      effect: write
      questions:
      - Is it possible to change only some of a placement group's settings?
      - Can I patch a single field on a placement group?
      instructions:
      - text: Patch a subset of placement group {name}'s config in project {project}.
        slots:
          name: path.name
          project: query.project
      - text: Update only the changed fields of the placement group.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/placement-groups?recursion=1'].get
  update:
    x-apievangelist-phrasing:
      intent: List placement groups with details
      effect: read
      questions:
      - Can I list placement groups with their full configuration expanded?
      - Which call returns placement group objects rather than URLs?
      instructions:
      - text: List full placement group records in project {project}.
        slots:
          project: query.project
      - text: Show expanded placement groups for all projects ({all}).
        slots:
          all: query.all-projects
      method: generated
      generated: '2026-09-26'