# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for 2026-07 Variant Attributes API
  version: 1.0.0
extends: openapi/lightspeed-variant-attributes-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: 5
- target: $.paths['/variant_attributes'].get
  update:
    x-apievangelist-phrasing:
      intent: List variant attributes
      effect: read
      questions:
      - Which variant attributes like Size or Color are defined in my store?
      - Can I include deleted variant attributes in the list?
      instructions:
      - text: List all variant attributes.
      - text: 'List variant attributes including deleted ones: {deleted}.'
        slots:
          deleted: query.deleted
      method: generated
      generated: '2026-09-26'
- target: $.paths['/variant_attributes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a variant attribute
      effect: write
      questions:
      - How do I add a new attribute like Size before creating variants?
      - What is needed to define a variant attribute?
      instructions:
      - text: Create a variant attribute named {name}.
        slots:
          name: requestBody.name
      - text: Add {name} as a new attribute for differentiating product variants.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/variant_attributes/{attribute-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single variant attribute
      effect: read
      questions:
      - How do I fetch one variant attribute by ID?
      - Can I look up a variant attribute even if it was deleted?
      instructions:
      - text: Get variant attribute {attribute-id}.
        slots:
          attribute-id: path.attribute-id
      - text: 'Show variant attribute {attribute-id}, including if deleted: {deleted}.'
        slots:
          attribute-id: path.attribute-id
          deleted: query.deleted
      method: generated
      generated: '2026-09-26'
- target: $.paths['/variant_attributes/{attribute-id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename a variant attribute
      effect: write
      questions:
      - How do I rename an existing variant attribute?
      - Can I change 'Colour' to 'Color' on an attribute already in use?
      instructions:
      - text: Rename variant attribute {attribute-id} to {name}.
        slots:
          attribute-id: path.attribute-id
          name: requestBody.name
      - text: Update the existing attribute {attribute-id} so its name is {name}.
        slots:
          attribute-id: path.attribute-id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/variant_attributes/{attribute-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a variant attribute
      effect: destructive
      questions:
      - Why can't I delete a variant attribute that's used by a product family?
      - How do I remove an unused variant attribute?
      instructions:
      - text: Delete variant attribute {attribute-id}.
        slots:
          attribute-id: path.attribute-id
      - text: Remove the unused variant attribute {attribute-id}.
        slots:
          attribute-id: path.attribute-id
      method: generated
      generated: '2026-09-26'