# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Azure API Management REST Product API
  version: 1.0.0
extends: openapi/microsoft-azure-api-management-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}/products'].get
  update:
    x-apievangelist-phrasing:
      intent: List products on the service
      effect: read
      questions:
      - What products are defined across my API Management service instance?
      - Can I see every service-level product I publish to developers?
      instructions:
      - text: List all products on my API Management service instance.
      - text: Show me every service-level product so I can review what is published.
      - text: List all products published on API Management service {serviceName}.
        slots:
          serviceName: path.serviceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a service-level product
      effect: read
      questions:
      - How do I see the settings of one product on my service?
      - Does a given service product require approval or a subscription?
      instructions:
      - text: Get the details of the service-level product I name.
      - text: Fetch this product's terms, state and subscription settings from the service.
      - text: Get the terms, state and settings of product {productId} on service {serviceName}.
        slots:
          productId: path.productId
          serviceName: path.serviceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a service product
      effect: write
      questions:
      - How do I create a new product to bundle APIs on my API Management service?
      - Can I overwrite a service-level product definition in one call?
      instructions:
      - text: Create a new product on the service with the ID I give you.
      - text: Create or fully replace the service-level product I name.
      - text: Create or fully replace service-level product {productId} on {serviceName}.
        slots:
          productId: path.productId
          serviceName: path.serviceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a service-level product
      effect: destructive
      questions:
      - How can I remove a product from my service instance?
      - What happens to a service product's subscriptions when I delete it?
      instructions:
      - text: Delete the service-level product I name.
      - text: Remove this product from the API Management service.
      - text: Delete service-level product {productId} from API Management service {serviceName}.
        slots:
          productId: path.productId
          serviceName: path.serviceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a service-level product
      effect: write
      questions:
      - Can I change just the description or state of an existing service product?
      - Is there a way to patch a product's details without redefining it?
      instructions:
      - text: Patch the existing service-level product I name with new details.
      - text: Publish or unpublish a service product by updating its state.
      - text: Publish or unpublish product {productId} on service {serviceName} by patching its state.
        slots:
          productId: path.productId
          serviceName: path.serviceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}'].head
  update:
    x-apievangelist-phrasing:
      intent: Get a service product's ETag
      effect: read
      questions:
      - Can I read a service product's ETag without downloading it?
      - What entity version is a product on my service at right now?
      instructions:
      - text: Check the ETag of the service-level product I name.
      - text: Confirm a product exists on the service by reading only its entity state.
      - text: Read only the ETag of service-level product {productId} on {serviceName}.
        slots:
          productId: path.productId
          serviceName: path.serviceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products'].get
  update:
    x-apievangelist-phrasing:
      intent: List products in a workspace
      effect: read
      questions:
      - Which products live inside one of my workspaces?
      - Can I list only the products owned by a single workspace?
      instructions:
      - text: List every product in the workspace I name.
      - text: Show me the workspace-scoped products for my team.
      - text: List every product in workspace {workspaceId} of service {serviceName}.
        slots:
          workspaceId: path.workspaceId
          serviceName: path.serviceName
      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 product in a workspace
      effect: read
      questions:
      - How do I read one workspace product's settings?
      - Does a product inside my workspace require subscription approval?
      instructions:
      - text: Get the workspace product with the ID I give you.
      - text: Fetch one product's details from inside my workspace.
      - text: Get product {productId} from inside workspace {workspaceId} on {serviceName}.
        slots:
          productId: path.productId
          workspaceId: path.workspaceId
          serviceName: path.serviceName
      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 product that belongs to a specific workspace?
      - Can I overwrite a workspace product definition in one request?
      instructions:
      - text: Create a new product inside the workspace I name.
      - text: Create or fully replace the workspace product I name.
      - text: Create or fully replace product {productId} in workspace {workspaceId} on {serviceName}.
        slots:
          productId: path.productId
          workspaceId: path.workspaceId
          serviceName: path.serviceName
      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 product in a workspace
      effect: destructive
      questions:
      - How can I remove a product from a workspace?
      - Is deleting a workspace product permanent?
      instructions:
      - text: Delete the workspace product I name.
      - text: Remove this product from my workspace.
      - text: Delete product {productId} from workspace {workspaceId} on service {serviceName}.
        slots:
          productId: path.productId
          workspaceId: path.workspaceId
          serviceName: path.serviceName
      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 a product in a workspace
      effect: write
      questions:
      - Can I patch a workspace product's description or state in place?
      - Is it possible to change a few fields on a product inside a workspace?
      instructions:
      - text: Patch the workspace product I name with new details.
      - text: Update the state of a product inside my workspace.
      - text: Patch the state of product {productId} in workspace {workspaceId} on {serviceName}.
        slots:
          productId: path.productId
          workspaceId: path.workspaceId
          serviceName: path.serviceName
      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:
      - Can I read a workspace product's ETag without its full body?
      - What entity version does a product in my workspace have?
      instructions:
      - text: Check the ETag of the workspace product I name.
      - text: Confirm a product exists in my workspace from its entity state alone.
      - text: Read only the ETag of workspace product {productId} in {workspaceId} on {serviceName}.
        slots:
          productId: path.productId
          workspaceId: path.workspaceId
          serviceName: path.serviceName
      method: generated
      generated: '2026-10-01'