Azure DevOps · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Azure DevOps Work Items Attachments API

3 actions 3 updates phrasing extends openapi/microsoft-azure-devops-attachments-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Azure DevOps's API. It is a proposal applied on top of the contract, not a document Azure DevOps publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/wit/attachments/{id}'].get
$.paths['/wit/attachments'].post

OpenAPI Overlay

Raw ↑
# 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 Attachments API
  version: 1.0.0
extends: openapi/microsoft-azure-devops-attachments-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/attachments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a work item attachment's details
      effect: read
      questions:
      - Where do I find the download URL for a file attached to a work item?
      - Can I see an attachment's file name, size and creation date before downloading it?
      instructions:
      - text: Get the details and download URL of attachment {id}.
        slots:
          id: path.id
      - text: Show me the file name and size of work item attachment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/wit/attachments'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a file as a work item attachment
      effect: write
      questions:
      - How do I upload a file so I can attach it to an Azure Boards work item?
      - Can I upload a large attachment in chunks rather than all at once?
      instructions:
      - text: Upload {fileName} as a new work item attachment.
        slots:
          fileName: query.fileName
      - text: Upload {fileName} as an attachment using the {uploadType} upload type.
        slots:
          fileName: query.fileName
          uploadType: query.uploadType
      method: generated
      generated: '2026-09-26'