# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Azure DevOps Releases API
  version: 1.0.0
extends: openapi/microsoft-azure-devops-releases-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/release/releases'].get
  update:
    x-apievangelist-phrasing:
      intent: List releases
      effect: read
      questions:
      - Which releases were created for a release definition this month?
      - Can I filter releases by status or environment status?
      instructions:
      - text: List releases for definition {definitionId}.
        slots:
          definitionId: query.definitionId
      - text: List releases with status {statusFilter} created after {minCreatedTime}.
        slots:
          statusFilter: query.statusFilter
          minCreatedTime: query.minCreatedTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/release/releases'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a release
      effect: write
      questions:
      - How do I start a new release from a release definition?
      - Can I create a release as a draft so it does not deploy automatically?
      instructions:
      - text: Create a release from definition {definitionId}.
        slots:
          definitionId: requestBody.definitionId
      - text: Create a draft release from definition {definitionId} described as {description}.
        slots:
          definitionId: requestBody.definitionId
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/release/releases/{releaseId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a release
      effect: read
      questions:
      - What is the deployment status of each environment in a release?
      - Which artifacts and approvals are attached to a particular release?
      instructions:
      - text: Show release {releaseId}.
        slots:
          releaseId: path.releaseId
      - text: Get the environment deployment status of release {releaseId}.
        slots:
          releaseId: path.releaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/release/releases/{releaseId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a release
      effect: write
      questions:
      - How do I move a draft release to active?
      - Can I mark an existing release to be kept forever?
      instructions:
      - text: Set the status of release {releaseId} to {status}.
        slots:
          releaseId: path.releaseId
          status: requestBody.status
      - text: Set keep forever to {keepForever} on release {releaseId}.
        slots:
          keepForever: requestBody.keepForever
          releaseId: path.releaseId
      method: generated
      generated: '2026-09-26'