API Evangelist conversational phrasing for act.web.api Products API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for act.web.api Products API
  version: 1.0.0
extends: openapi/act-products-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['/api/Products/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a product
      effect: read
      questions:
      - What's the price and cost of a particular product?
      - Can I look up one product by id?
      instructions:
      - text: Get product {id}.
        slots:
          id: path.id
      - text: Show the details of product {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/Products/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a product's details
      effect: write
      questions:
      - How do I overwrite a product with a full new set of name, price and cost?
      - Can I fully redefine a product record in one call?
      instructions:
      - text: Replace product {id} with name {name}, price {price} and cost {cost}.
        slots:
          id: path.id
          name: requestBody.name
          price: requestBody.price
          cost: requestBody.cost
      - text: Do a full update of product {id} with item number {itemNumber}.
        slots:
          id: path.id
          itemNumber: requestBody.itemNumber
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/Products/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a product
      effect: destructive
      questions:
      - Can I remove a product I no longer sell?
      - Is deleting a product from the catalog permanent?
      instructions:
      - text: Delete product {id}.
        slots:
          id: path.id
      - text: Remove product {id} from the product list.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/Products/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change selected fields on a product
      effect: write
      questions:
      - Can I change just a product's price without touching the rest?
      - Is there a partial update for products?
      instructions:
      - text: Change only the price of product {id} to {price}.
        slots:
          id: path.id
          price: requestBody.price
      - text: Patch product {id} so its cost is {cost}.
        slots:
          id: path.id
          cost: requestBody.cost
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/Products'].get
  update:
    x-apievangelist-phrasing:
      intent: List products
      effect: read
      questions:
      - What products are in my catalog?
      - Can I filter my product list with an OData query?
      instructions:
      - text: List all products.
      - text: Show my whole product catalog.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/Products'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a product
      effect: write
      questions:
      - How do I add a new product with a price and cost?
      - Can I give a new product an item number?
      instructions:
      - text: Create a product named {name} priced at {price}.
        slots:
          name: requestBody.name
          price: requestBody.price
      - text: Add product {name} with item number {itemNumber}, cost {cost} and price {price}.
        slots:
          name: requestBody.name
          itemNumber: requestBody.itemNumber
          cost: requestBody.cost
          price: requestBody.price
      method: generated
      generated: '2026-10-01'