# 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 ApiManagementClient API Release API
  version: 1.0.0
extends: openapi/microsoft-azure-apirelease-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/{workspaceId}/apis/{apiId}/releases'].get
  update:
    x-apievangelist-phrasing:
      intent: List releases of a workspace API
      effect: read
      questions:
      - What releases has my API Management workspace API gone through?
      - Can I filter API releases by their notes?
      instructions:
      - text: List every release of API {api} in workspace {workspace} on APIM service {service}.
        slots:
          api: path.apiId
          workspace: path.workspaceId
          service: path.serviceName
      - text: Show API releases whose notes match {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/releases/{releaseId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an API release
      effect: read
      questions:
      - Which revision does a particular API release point at?
      - Can I read the notes of a single API release?
      instructions:
      - text: Get release {release} of API {api} in workspace {workspace} on service {service}.
        slots:
          release: path.releaseId
          api: path.apiId
          workspace: path.workspaceId
          service: path.serviceName
      - text: Show the notes and revision behind API release {release}.
        slots:
          release: path.releaseId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/releases/{releaseId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a release for a workspace API
      effect: write
      questions:
      - How do I make an API revision current by releasing it?
      - Can I roll a workspace API back by creating a release for an older revision?
      instructions:
      - text: Create release {release} for API {api} in workspace {workspace} on service {service}, making its revision current.
        slots:
          release: path.releaseId
          api: path.apiId
          workspace: path.workspaceId
          service: path.serviceName
      - text: Release the current revision of workspace API {api} as {release}.
        slots:
          api: path.apiId
          release: path.releaseId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/releases/{releaseId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an API release
      effect: destructive
      questions:
      - How do I delete a release from a workspace API?
      - Can I remove an API release I created by mistake?
      instructions:
      - text: Delete release {release} from API {api} in workspace {workspace} on service {service}.
        slots:
          release: path.releaseId
          api: path.apiId
          workspace: path.workspaceId
          service: path.serviceName
      - text: Remove the mistaken API release {release}.
        slots:
          release: path.releaseId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/releases/{releaseId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an API release's details
      effect: write
      questions:
      - Can I edit the notes of an existing API release?
      - How do I change the details of a release after creating it?
      instructions:
      - text: Update the notes on existing release {release} of API {api} in workspace {workspace}, service {service}.
        slots:
          release: path.releaseId
          api: path.apiId
          workspace: path.workspaceId
          service: path.serviceName
      - text: Patch the details of API release {release}.
        slots:
          release: path.releaseId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/releases/{releaseId}'].head
  update:
    x-apievangelist-phrasing:
      intent: Get the ETag of an API release
      effect: read
      questions:
      - How do I get the current ETag of an API release before updating it?
      - Is there a lightweight way to check whether an API release exists?
      instructions:
      - text: Get the ETag of release {release} on API {api} in workspace {workspace}, service {service}.
        slots:
          release: path.releaseId
          api: path.apiId
          workspace: path.workspaceId
          service: path.serviceName
      - text: Check whether API release {release} exists without fetching its body.
        slots:
          release: path.releaseId
      method: generated
      generated: '2026-10-01'