# 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 Issue API
  version: 1.0.0
extends: openapi/microsoft-azure-api-management-apiissue-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}/apis/{apiId}/issues'].get
  update:
    x-apievangelist-phrasing:
      intent: List issues reported against an API
      effect: read
      questions:
      - What issues have developers raised about one of my APIs?
      - Can I see every issue filed on a specific API in the developer portal?
      instructions:
      - text: List all issues reported against API {apiId} on service {serviceName}.
        slots:
          apiId: path.apiId
          serviceName: path.serviceName
      - text: Show the open and closed issues reported on the API.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one issue on an API
      effect: read
      questions:
      - How do I read the full details of a single issue filed on an API?
      - What state and author does a particular API issue have?
      instructions:
      - text: Get the details of issue {issueId} reported on API {apiId} in {serviceName}.
        slots:
          issueId: path.issueId
          apiId: path.apiId
          serviceName: path.serviceName
      - text: Show me the issue details by its identifier.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Report a new issue on an API
      effect: write
      questions:
      - How do I file an issue against an API in API Management?
      - Can I overwrite an existing API issue with a fresh definition?
      instructions:
      - text: Create issue {issueId} on API {apiId} in my {serviceName} service, or replace it if it exists.
        slots:
          issueId: path.issueId
          apiId: path.apiId
          serviceName: path.serviceName
      - text: Log an issue on the API or replace the existing one.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an issue from an API
      effect: destructive
      questions:
      - Can I remove an issue that was filed on an API by mistake?
      - Is deleting an API issue permanent?
      instructions:
      - text: Delete issue {issueId} from API {apiId} on service {serviceName}.
        slots:
          issueId: path.issueId
          apiId: path.apiId
          serviceName: path.serviceName
      - text: Remove the mistaken issue report.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an existing API issue
      effect: write
      questions:
      - Can I change the state of an issue, for example to resolved?
      - Is there a way to edit the title or description of an API issue after filing?
      instructions:
      - text: Update existing issue {issueId} on API {apiId} in my {serviceName} instance.
        slots:
          issueId: path.issueId
          apiId: path.apiId
          serviceName: path.serviceName
      - text: Mark the issue on the API as resolved.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}'].head
  update:
    x-apievangelist-phrasing:
      intent: Check an API issue's ETag
      effect: read
      questions:
      - How do I get the ETag of an API issue before editing it?
      - Can I check an issue exists without loading it?
      instructions:
      - text: Get the ETag version of issue {issueId} on API {apiId} in service {serviceName}.
        slots:
          issueId: path.issueId
          apiId: path.apiId
          serviceName: path.serviceName
      - text: Check the ETag on the issue.
      method: generated
      generated: '2026-10-01'