# 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 API Policy API
  version: 1.0.0
extends: openapi/microsoft-azure-api-management-apipolicy-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: 5
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies'].get
  update:
    x-apievangelist-phrasing:
      intent: List the policies set on an API
      effect: read
      questions:
      - What policies are applied at the level of one API?
      - Can I see all policy configurations attached to a specific API?
      instructions:
      - text: List the policies configured on API {apiId} in service {serviceName}.
        slots:
          apiId: path.apiId
          serviceName: path.serviceName
      - text: Show the API-level policy collection.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an API's policy document
      effect: read
      questions:
      - How do I read the XML policy that runs for one API?
      - Can I fetch an API's policy in raw XML format?
      instructions:
      - text: Get policy {policyId} configured on API {apiId} in service {serviceName}.
        slots:
          policyId: path.policyId
          apiId: path.apiId
          serviceName: path.serviceName
      - text: Show me the API-level policy XML.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set the policy on an API
      effect: write
      questions:
      - How do I add rate limiting or header rewrites to a single API?
      - Can I replace an API's whole policy document in one call?
      instructions:
      - text: Set policy {policyId} on API {apiId} in service {serviceName} to my new XML.
        slots:
          policyId: path.policyId
          apiId: path.apiId
          serviceName: path.serviceName
      - text: Replace the API-level policy with my new XML.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove the policy from an API
      effect: destructive
      questions:
      - Can I strip all policies off one API?
      - What happens to requests once an API's policy is deleted?
      instructions:
      - text: Delete policy {policyId} from API {apiId} in service {serviceName}.
        slots:
          policyId: path.policyId
          apiId: path.apiId
          serviceName: path.serviceName
      - text: Remove the API-level policy.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId}'].head
  update:
    x-apievangelist-phrasing:
      intent: Check an API policy's ETag
      effect: read
      questions:
      - How do I get the ETag of an API's policy before overwriting it?
      - Can I check whether an API has a policy without downloading it?
      instructions:
      - text: Get the entity tag version of policy {policyId} on API {apiId} in service {serviceName}.
        slots:
          policyId: path.policyId
          apiId: path.apiId
          serviceName: path.serviceName
      - text: Check whether the API has a policy set.
      method: generated
      generated: '2026-10-01'