# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure Contoso Widget Manager Widgets API
  version: 1.0.0
extends: openapi/microsoft-azure-widgets-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['/widgets'].get
  update:
    x-apievangelist-phrasing:
      intent: List widget resources
      effect: read
      questions:
      - Which widgets exist in this sample service?
      - Can I see every widget resource at once?
      instructions:
      - text: List all widgets.
      - text: Show every widget resource on API version {api_version}.
        slots:
          api_version: query.api-version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/widgets/{widgetName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch a widget by name
      effect: read
      questions:
      - What manufacturer is a particular widget from?
      - Can I look up one widget by its name?
      instructions:
      - text: Show widget {widgetName}.
        slots:
          widgetName: path.widgetName
      - text: Fetch the details of the widget called {widgetName}.
        slots:
          widgetName: path.widgetName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/widgets/{widgetName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a widget
      effect: destructive
      questions:
      - Can I remove a widget I no longer need?
      - Does deleting a widget happen in the background?
      instructions:
      - text: Delete widget {widgetName}.
        slots:
          widgetName: path.widgetName
      - text: Start the asynchronous removal of widget {widgetName}.
        slots:
          widgetName: path.widgetName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/widgets/{widgetName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Create or update a widget
      effect: write
      questions:
      - How do I create a widget and set who manufactured it?
      - Can I change the manufacturer of a widget that already exists?
      instructions:
      - text: Create widget {widgetName} made by manufacturer {manufacturerId}.
        slots:
          widgetName: path.widgetName
          manufacturerId: requestBody.manufacturerId
      - text: Set the manufacturer of widget {widgetName} to {manufacturerId}.
        slots:
          widgetName: path.widgetName
          manufacturerId: requestBody.manufacturerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/widgets/{widgetName}/operations/{operationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a widget operation's status
      effect: read
      questions:
      - Has the background create or delete on my widget finished?
      - Can I poll a long-running widget operation?
      instructions:
      - text: Check the status of operation {operationId} on widget {widgetName}.
        slots:
          operationId: path.operationId
          widgetName: path.widgetName
      - text: Tell me whether widget {widgetName}'s operation {operationId} completed.
        slots:
          widgetName: path.widgetName
          operationId: path.operationId
      method: generated
      generated: '2026-09-26'