# 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 Release Definitions API
  version: 1.0.0
extends: openapi/microsoft-azure-devops-release-definitions-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: 5
- target: $.paths['/release/definitions'].get
  update:
    x-apievangelist-phrasing:
      intent: List release definitions
      effect: read
      questions:
      - What classic release pipelines are defined in my project?
      - Can I search release definitions by name or folder?
      instructions:
      - text: List all release definitions.
      - text: Search release definitions for {searchText} in folder {path}.
        slots:
          searchText: query.searchText
          path: query.path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/release/definitions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a release definition
      effect: write
      questions:
      - How do I set up a new classic release pipeline with its environments and artifacts?
      - Can I define triggers and variables when creating a release definition?
      instructions:
      - text: Create a release definition named {name} with environments {environments}.
        slots:
          name: requestBody.name
          environments: requestBody.environments
      - text: Create release definition {name} deploying artifacts {artifacts}.
        slots:
          name: requestBody.name
          artifacts: requestBody.artifacts
      method: generated
      generated: '2026-09-26'
- target: $.paths['/release/definitions/{definitionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a release definition
      effect: read
      questions:
      - Which environments and artifact sources does a release definition use?
      - Can I see the triggers and approvals on one release pipeline?
      instructions:
      - text: Show release definition {definitionId}.
        slots:
          definitionId: path.definitionId
      - text: Get the environments and triggers of release definition {definitionId}.
        slots:
          definitionId: path.definitionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/release/definitions/{definitionId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a release definition
      effect: write
      questions:
      - How do I change the environments of an existing release definition?
      - Why does updating a release definition need the current revision number?
      instructions:
      - text: Update release definition {definitionId} with environments {environments}.
        slots:
          definitionId: path.definitionId
          environments: requestBody.environments
      - text: Change the variables of existing release definition {definitionId} to {variables}.
        slots:
          definitionId: path.definitionId
          variables: requestBody.variables
      method: generated
      generated: '2026-09-26'
- target: $.paths['/release/definitions/{definitionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a release definition
      effect: destructive
      questions:
      - Can I delete a release definition that still has releases?
      - Is there a way to record a reason when deleting a release pipeline?
      instructions:
      - text: Delete release definition {definitionId}.
        slots:
          definitionId: path.definitionId
      - text: Force delete release definition {definitionId} with comment {comment}.
        slots:
          definitionId: path.definitionId
          comment: query.comment
      method: generated
      generated: '2026-09-26'