# 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 Profiles API
  version: 1.0.0
extends: openapi/canonical-profiles-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/profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List URLs of LXD profiles
      effect: read
      questions:
      - Which instance profiles exist in a project, as links?
      - Can I list profile URLs across all projects?
      instructions:
      - text: List profile URLs in project {project}.
        slots:
          project: query.project
      - text: Give me profile links across all projects with all-projects {all-projects}.
        slots:
          all-projects: query.all-projects
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1.0/profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an instance profile
      effect: write
      questions:
      - How do I create a reusable profile for LXD instances?
      - Can I attach devices like disks or NICs to a new profile?
      instructions:
      - text: Create profile {name} with config {config}.
        slots:
          name: requestBody.name
          config: requestBody.config
      - text: Add profile {name} in project {project} with devices {devices}.
        slots:
          name: requestBody.name
          project: query.project
          devices: requestBody.devices
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1.0/profiles/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one instance profile
      effect: read
      questions:
      - What config and devices does a particular profile set?
      - Can I look up one profile by name?
      instructions:
      - text: Show profile {name} in project {project}.
        slots:
          name: path.name
          project: query.project
      - text: Look up a single instance profile's settings.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/profiles/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a profile's entire configuration
      effect: write
      questions:
      - How do I overwrite a profile's config and devices completely?
      - Will a full profile update drop devices I leave out?
      instructions:
      - text: Replace the devices of profile {name} entirely with {devices}.
        slots:
          name: path.name
          devices: requestBody.devices
      - text: Rewrite the whole profile with config {config} and description {description}.
        slots:
          config: requestBody.config
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/profiles/{name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename an instance profile
      effect: write
      questions:
      - Can I rename an LXD profile?
      - What's the call to give a profile a new name?
      instructions:
      - text: Rename profile {name} to {new_name}.
        slots:
          name: path.name
          new_name: requestBody.name
      - text: Give profile {name} the new name {new_name} in project {project}.
        slots:
          name: path.name
          new_name: requestBody.name
          project: query.project
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/profiles/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an instance profile
      effect: destructive
      questions:
      - How do I remove a profile I no longer use?
      - Can I delete a profile from a specific project?
      instructions:
      - text: Delete profile {name}.
        slots:
          name: path.name
      - text: Remove the profile from project {project}.
        slots:
          project: query.project
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/profiles/{name}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change some of a profile's settings
      effect: write
      questions:
      - Can I tweak one profile key without resending the whole profile?
      - Is there a partial update for instance profiles?
      instructions:
      - text: 'Patch only these config keys on profile {name}: {config}.'
        slots:
          name: path.name
          config: requestBody.config
      - text: Add or change devices {devices} on the profile, leaving the rest.
        slots:
          devices: requestBody.devices
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/profiles?recursion=1'].get
  update:
    x-apievangelist-phrasing:
      intent: List LXD profiles with full config
      effect: read
      questions:
      - Can I see every profile's devices and config in one call?
      - What settings do all my instance profiles apply?
      instructions:
      - text: Fetch every profile with devices and config in project {project}.
        slots:
          project: query.project
      - text: Show all profiles in full, not just URLs.
      method: generated
      generated: '2026-09-26'