# 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 Work Items Comments API
  version: 1.0.0
extends: openapi/microsoft-azure-devops-comments-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: 2
- target: $.paths['/wit/workitems/{id}/comments'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on a work item
      effect: read
      questions:
      - What discussion has happened on a bug or task in Azure Boards?
      - Can I page through a work item's comments in batches?
      instructions:
      - text: Show the comments on work item {id}.
        slots:
          id: path.id
      - text: List the first {top} comments on work item {id}.
        slots:
          top: query.$top
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/wit/workitems/{id}/comments'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a comment to a work item
      effect: write
      questions:
      - How do I post a note to a work item's discussion?
      - Can a work item comment include HTML formatting?
      instructions:
      - text: Comment {text} on work item {id}.
        slots:
          text: requestBody.text
          id: path.id
      - text: Add the note {text} to the discussion of work item {id}.
        slots:
          text: requestBody.text
          id: path.id
      method: generated
      generated: '2026-09-26'