# 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 Release API
  version: 1.0.0
extends: openapi/microsoft-azure-api-management-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}/apis/{apiId}/releases'].get
  update:
    x-apievangelist-phrasing:
      intent: List the releases of an API
      effect: read
      questions:
      - What releases have been made for one of my APIs?
      - Can I see the history of revisions made current, so I know what to roll back to?
      instructions:
      - text: List the release history of API {apiId} on service {serviceName}.
        slots:
          apiId: path.apiId
          serviceName: path.serviceName
      - text: Show the API's release history.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases/{releaseId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an API release
      effect: read
      questions:
      - How do I see the notes and revision behind a specific API release?
      - Which revision does a given release point to?
      instructions:
      - text: Get the details of release {releaseId} of API {apiId} in service {serviceName}.
        slots:
          releaseId: path.releaseId
          apiId: path.apiId
          serviceName: path.serviceName
      - text: Show me the release by its identifier.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases/{releaseId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a release for an API
      effect: write
      questions:
      - How do I release an API revision so it becomes current?
      - Can I roll back to an earlier revision by creating a release for it?
      instructions:
      - text: Create release {releaseId} for API {apiId} on service {serviceName}.
        slots:
          releaseId: path.releaseId
          apiId: path.apiId
          serviceName: path.serviceName
      - text: Publish a release that makes the chosen revision current.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases/{releaseId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an API release
      effect: destructive
      questions:
      - Can I delete a release from an API's history?
      - Does removing a release change which revision is live?
      instructions:
      - text: Delete release {releaseId} from API {apiId} in {serviceName}.
        slots:
          releaseId: path.releaseId
          apiId: path.apiId
          serviceName: path.serviceName
      - text: Remove the API release record.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases/{releaseId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an API release's details
      effect: write
      questions:
      - Can I edit the release notes on an existing API release?
      - Is a release editable after it has been created?
      instructions:
      - text: Update the notes on existing release {releaseId} of API {apiId} in {serviceName}.
        slots:
          releaseId: path.releaseId
          apiId: path.apiId
          serviceName: path.serviceName
      - text: Patch the details of the existing release.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases/{releaseId}'].head
  update:
    x-apievangelist-phrasing:
      intent: Check an API release's ETag
      effect: read
      questions:
      - How do I get the ETag of an API release?
      - Can I confirm a release exists with a lightweight check?
      instructions:
      - text: Get the ETag of release {releaseId} for API {apiId} on {serviceName}.
        slots:
          releaseId: path.releaseId
          apiId: path.apiId
          serviceName: path.serviceName
      - text: Check the ETag for the release.
      method: generated
      generated: '2026-10-01'