# 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 Warnings API
  version: 1.0.0
extends: openapi/canonical-warnings-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: 6
- target: $.paths['/1.0/warnings'].get
  update:
    x-apievangelist-phrasing:
      intent: List warnings as URLs
      effect: read
      questions:
      - Are there any warnings raised on my LXD server, as a list of links?
      - Can I list only the warnings for one project?
      instructions:
      - text: List warning URLs for project {project}.
        slots:
          project: query.project
      - text: Give me links to every warning on the server.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1.0/warnings/{uuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one warning
      effect: read
      questions:
      - What is a specific warning about and when did it last occur?
      - Can I look up a warning by its UUID?
      instructions:
      - text: Show warning {uuid}.
        slots:
          uuid: path.uuid
      - text: Look up one LXD warning's details.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/warnings/{uuid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a warning's status
      effect: write
      questions:
      - How do I acknowledge an LXD warning so it stops showing as new?
      - Can I replace a warning's status outright?
      instructions:
      - text: Set the status of warning {uuid} to {status}.
        slots:
          uuid: path.uuid
          status: requestBody.status
      - text: Mark this warning as {status} with a full update.
        slots:
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/warnings/{uuid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a warning
      effect: destructive
      questions:
      - How do I remove a warning from LXD entirely?
      - Can I delete a warning rather than just acknowledging it?
      instructions:
      - text: Delete warning {uuid}.
        slots:
          uuid: path.uuid
      - text: Remove this warning permanently.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/warnings/{uuid}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a warning's status
      effect: write
      questions:
      - Is there a partial update I can use to change just a warning's status?
      - Can I patch a warning instead of replacing it?
      instructions:
      - text: Patch warning {uuid} so its status becomes {status}.
        slots:
          uuid: path.uuid
          status: requestBody.status
      - text: Partially update this warning to {status}.
        slots:
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/warnings?recursion=1'].get
  update:
    x-apievangelist-phrasing:
      intent: List warnings with full details
      effect: read
      questions:
      - What do all the current LXD warnings actually say?
      - Can I see each warning's status and message in one call?
      instructions:
      - text: Fetch every warning with full details in project {project}.
        slots:
          project: query.project
      - text: Show all warnings with their messages and status, not just URLs.
      method: generated
      generated: '2026-09-26'