# 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 Workspace API
  version: 1.0.0
extends: openapi/microsoft-azure-api-management-workspace-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['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List workspaces on the service
      effect: read
      questions:
      - Which workspaces exist in my API Management service instance?
      - Can I see every team workspace on the service?
      instructions:
      - text: List all workspaces on my API Management service {serviceName}.
        slots:
          serviceName: path.serviceName
      - text: Show me every workspace so I can see how teams are split.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workspace's details
      effect: read
      questions:
      - How do I look up one workspace's display name and description?
      - What is configured on a particular workspace?
      instructions:
      - text: Get workspace {workspaceId} on API Management service {serviceName}.
        slots:
          workspaceId: path.workspaceId
          serviceName: path.serviceName
      - text: Show me this workspace's details.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a workspace
      effect: write
      questions:
      - How do I create a new workspace for a team in API Management?
      - Can I overwrite an existing workspace's definition in one call?
      instructions:
      - text: Create a new workspace {workspaceId} on service {serviceName}.
        slots:
          workspaceId: path.workspaceId
          serviceName: path.serviceName
      - text: Create or fully replace this workspace.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a workspace
      effect: destructive
      questions:
      - How can I remove a workspace from my service instance?
      - Is deleting a workspace permanent?
      instructions:
      - text: Delete workspace {workspaceId} from service {serviceName}.
        slots:
          workspaceId: path.workspaceId
          serviceName: path.serviceName
      - text: Remove this workspace from the service.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a workspace
      effect: write
      questions:
      - Can I rename a workspace or change its description in place?
      - Is there a way to patch an existing workspace?
      instructions:
      - text: Patch the existing workspace {workspaceId} on service {serviceName} with new details.
        slots:
          workspaceId: path.workspaceId
          serviceName: path.serviceName
      - text: Rename this workspace.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}'].head
  update:
    x-apievangelist-phrasing:
      intent: Get a workspace's ETag
      effect: read
      questions:
      - Can I read a workspace's ETag before updating it?
      - Does a workspace with a given ID exist on my service?
      instructions:
      - text: Check the ETag of workspace {workspaceId} on service {serviceName}.
        slots:
          workspaceId: path.workspaceId
          serviceName: path.serviceName
      - text: Confirm this workspace exists from its entity state header.
      method: generated
      generated: '2026-10-01'