# 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 Product API
  version: 1.0.0
extends: openapi/microsoft-azure-product-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: 12
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products'].get
  update:
    x-apievangelist-phrasing:
      intent: List API Management products in a workspace
      effect: read
      questions:
      - Which API Management products are published in one workspace of my service?
      - Can I filter workspace products by tag or include their developer groups?
      instructions:
      - text: List the products in workspace {workspaceId} of API Management service {serviceName}.
        slots:
          workspaceId: path.workspaceId
          serviceName: path.serviceName
      - text: 'List workspace products matching filter {filter} and include their groups: {expandGroups}.'
        slots:
          filter: query.$filter
          expandGroups: query.expandGroups
      - text: Show workspace products tagged {tags}.
        slots:
          tags: query.tags
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workspace product's details
      effect: read
      questions:
      - How do I look up the terms, state and approval settings of one workspace product?
      - What does a specific API Management workspace product contain?
      instructions:
      - text: Get the details of product {productId} in workspace {workspaceId} of API Management service {serviceName}.
        slots:
          productId: path.productId
          workspaceId: path.workspaceId
          serviceName: path.serviceName
      - text: Show the full definition of the workspace product by its identifier.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a workspace product
      effect: write
      questions:
      - How do I create a new product inside an API Management workspace?
      - Can I overwrite an existing workspace product definition in one call?
      instructions:
      - text: Create product {productId} in workspace {workspaceId} of API Management service {serviceName}.
        slots:
          productId: path.productId
          workspaceId: path.workspaceId
          serviceName: path.serviceName
      - text: Replace the workspace product definition with a new one.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a workspace product
      effect: destructive
      questions:
      - How do I remove a product from an API Management workspace?
      - Can I delete a workspace product and all of its existing subscriptions at once?
      instructions:
      - text: Delete product {productId} from workspace {workspaceId} in API Management service {serviceName}.
        slots:
          productId: path.productId
          workspaceId: path.workspaceId
          serviceName: path.serviceName
      - text: 'Delete the workspace product, removing its subscriptions: {deleteSubscriptions}.'
        slots:
          deleteSubscriptions: query.deleteSubscriptions
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an existing workspace product
      effect: write
      questions:
      - Can I change just a few fields on a workspace product without replacing it?
      - How do I patch an existing API Management workspace product?
      instructions:
      - text: Patch the existing details of product {productId} in workspace {workspaceId} on service {serviceName}.
        slots:
          productId: path.productId
          workspaceId: path.workspaceId
          serviceName: path.serviceName
      - text: Update selected fields on this workspace product only.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}'].head
  update:
    x-apievangelist-phrasing:
      intent: Get a workspace product's ETag
      effect: read
      questions:
      - How can I get just the ETag version of a workspace product before updating it?
      - Is there a lightweight check that a workspace product exists without fetching its body?
      instructions:
      - text: Fetch only the entity tag of product {productId} in workspace {workspaceId} on service {serviceName}.
        slots:
          productId: path.productId
          workspaceId: path.workspaceId
          serviceName: path.serviceName
      - text: Check the current ETag version of the workspace product.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/products'].get
  update:
    x-apievangelist-phrasing:
      intent: List Azure Stack marketplace products
      effect: read
      questions:
      - Which marketplace products are available to my Azure Stack registration?
      - Can I see every product offered under an Azure Stack registration?
      instructions:
      - text: List the products available to Azure Stack registration {registrationName} in resource group {resourceGroup}.
        slots:
          registrationName: path.registrationName
          resourceGroup: path.resourceGroup
      - text: Show all marketplace items for this Azure Stack registration.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/products/{productName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an Azure Stack marketplace product
      effect: read
      questions:
      - How do I view one Azure Stack marketplace product by name?
      - What publisher and version details does an Azure Stack product have?
      instructions:
      - text: Get Azure Stack product {productName} under registration {registrationName} in resource group {resourceGroup}.
        slots:
          productName: path.productName
          registrationName: path.registrationName
          resourceGroup: path.resourceGroup
      - text: Show the registration's marketplace item {productName}.
        slots:
          productName: path.productName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/products/{productName}/listDetails'].post
  update:
    x-apievangelist-phrasing:
      intent: Get extended properties of an Azure Stack product
      effect: read
      questions:
      - Where can I find the extended properties, like download size, of an Azure Stack product?
      - Can I get the detailed metadata of a marketplace item beyond its basic fields?
      instructions:
      - text: List the extended details of Azure Stack product {productName} on registration {registrationName} in group {resourceGroup}.
        slots:
          productName: path.productName
          registrationName: path.registrationName
          resourceGroup: path.resourceGroup
      - text: Get the extended properties for marketplace item {productName}.
        slots:
          productName: path.productName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/products/{productName}/getProducts'].post
  update:
    x-apievangelist-phrasing:
      intent: List products for an Azure Stack device configuration
      effect: read
      questions:
      - Which Azure Stack products apply to my specific device configuration?
      - Can I pass my stamp's device configuration to get a matching product list?
      instructions:
      - text: Get the product list related to {productName} for device configuration {deviceConfiguration}.
        slots:
          productName: path.productName
          deviceConfiguration: body.deviceConfiguration
      - text: List compatible Azure Stack products starting from {productName} on registration {registrationName} in group {resourceGroup}.
        slots:
          productName: path.productName
          registrationName: path.registrationName
          resourceGroup: path.resourceGroup
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/products/{productName}/getProduct'].post
  update:
    x-apievangelist-phrasing:
      intent: Get an Azure Stack product for a device configuration
      effect: read
      questions:
      - How do I fetch one Azure Stack product as it applies to my device configuration?
      - Can I check a single marketplace item against my stamp's configuration?
      instructions:
      - text: Get product {productName} for device configuration {deviceConfiguration}.
        slots:
          productName: path.productName
          deviceConfiguration: body.deviceConfiguration
      - text: Retrieve Azure Stack product {productName} using the POST lookup for registration {registrationName} in group {resourceGroup}.
        slots:
          productName: path.productName
          registrationName: path.registrationName
          resourceGroup: path.resourceGroup
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/products/{productName}/uploadProductLog'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a marketplace product log for Azure Stack
      effect: write
      questions:
      - How do I report the download or install status of an Azure Stack marketplace product?
      - Can I send a product log update for a marketplace item back to Azure?
      instructions:
      - text: Upload a product log for {productName} with {marketplaceProductLogUpdate}.
        slots:
          productName: path.productName
          marketplaceProductLogUpdate: body.marketplaceProductLogUpdate
      - text: Submit the marketplace product log for Azure Stack item {productName} on registration {registrationName} in group {resourceGroup}.
        slots:
          productName: path.productName
          registrationName: path.registrationName
          resourceGroup: path.resourceGroup
      method: generated
      generated: '2026-10-01'