Azure DevOps · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Azure DevOps Git Repositories Pull Requests API

7 actions 7 updates phrasing extends openapi/microsoft-azure-devops-pull-requests-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 7

$.info
$.paths['/git/repositories/{repositoryId}/pullrequests'].get
$.paths['/git/repositories/{repositoryId}/pullrequests'].post
$.paths['/git/repositories/{repositoryId}/pullrequests/{pullRequestId}'].get
$.paths['/git/repositories/{repositoryId}/pullrequests/{pullRequestId}'].patch
$.paths['/git/repositories/{repositoryId}/pullrequests/{pullRequestId}/threads'].get
$.paths['/git/repositories/{repositoryId}/pullrequests/{pullRequestId}/threads'].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 Git Repositories Pull Requests API
  version: 1.0.0
extends: openapi/microsoft-azure-devops-pull-requests-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: 6
- target: $.paths['/git/repositories/{repositoryId}/pullrequests'].get
  update:
    x-apievangelist-phrasing:
      intent: List pull requests in a repository
      effect: read
      questions:
      - Which pull requests are still open against main in a repository?
      - Can I find the pull requests where I am a reviewer?
      - What pull requests has a given person created?
      instructions:
      - text: List active pull requests in repository {repositoryId}.
        slots:
          repositoryId: path.repositoryId
      - text: List pull requests in {repositoryId} targeting {targetRefName} with status {status}.
        slots:
          repositoryId: path.repositoryId
          targetRefName: query.searchCriteria.targetRefName
          status: query.searchCriteria.status
      - text: Find pull requests in {repositoryId} reviewed by {reviewerId}.
        slots:
          repositoryId: path.repositoryId
          reviewerId: query.searchCriteria.reviewerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/git/repositories/{repositoryId}/pullrequests'].post
  update:
    x-apievangelist-phrasing:
      intent: Open a pull request
      effect: write
      questions:
      - How do I open a pull request from my feature branch into main?
      - Can I create a draft pull request with reviewers and linked work items?
      instructions:
      - text: Open a pull request titled {title} in {repositoryId} from {sourceRefName} into {targetRefName}.
        slots:
          title: requestBody.title
          repositoryId: path.repositoryId
          sourceRefName: requestBody.sourceRefName
          targetRefName: requestBody.targetRefName
      - text: Create a draft PR {title} in {repositoryId} from {sourceRefName} to {targetRefName} with reviewers {reviewers}.
        slots:
          title: requestBody.title
          repositoryId: path.repositoryId
          sourceRefName: requestBody.sourceRefName
          targetRefName: requestBody.targetRefName
          reviewers: requestBody.reviewers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/git/repositories/{repositoryId}/pullrequests/{pullRequestId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pull request
      effect: read
      questions:
      - What is the merge status and reviewer vote on a specific pull request?
      - Can I see the commits and linked work items of one pull request?
      instructions:
      - text: Show pull request {pullRequestId} in repository {repositoryId}.
        slots:
          pullRequestId: path.pullRequestId
          repositoryId: path.repositoryId
      - text: Get pull request {pullRequestId} in {repositoryId} with its commits and work item links.
        slots:
          pullRequestId: path.pullRequestId
          repositoryId: path.repositoryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/git/repositories/{repositoryId}/pullrequests/{pullRequestId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update, complete or abandon a pull request
      effect: write
      questions:
      - How do I abandon or complete an existing pull request?
      - Can I retarget an open pull request to a different branch or change its title?
      instructions:
      - text: Set pull request {pullRequestId} in {repositoryId} to status {status}.
        slots:
          pullRequestId: path.pullRequestId
          repositoryId: path.repositoryId
          status: requestBody.status
      - text: Retarget pull request {pullRequestId} in {repositoryId} to {targetRefName}.
        slots:
          pullRequestId: path.pullRequestId
          repositoryId: path.repositoryId
          targetRefName: requestBody.targetRefName
      - text: Enable auto-complete on pull request {pullRequestId} in {repositoryId} set by {autoCompleteSetBy}.
        slots:
          pullRequestId: path.pullRequestId
          repositoryId: path.repositoryId
          autoCompleteSetBy: requestBody.autoCompleteSetBy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/git/repositories/{repositoryId}/pullrequests/{pullRequestId}/threads'].get
  update:
    x-apievangelist-phrasing:
      intent: List a pull request's comment threads
      effect: read
      questions:
      - What review comments have been left on a pull request?
      - Can I see code review comments together with the file position they refer to?
      instructions:
      - text: List the comment threads on pull request {pullRequestId} in {repositoryId}.
        slots:
          pullRequestId: path.pullRequestId
          repositoryId: path.repositoryId
      - text: Show review feedback on PR {pullRequestId} in repository {repositoryId}.
        slots:
          pullRequestId: path.pullRequestId
          repositoryId: path.repositoryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/git/repositories/{repositoryId}/pullrequests/{pullRequestId}/threads'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a comment thread on a pull request
      effect: write
      questions:
      - How do I leave a review comment on a specific file in a pull request?
      - Can I post a general comment on a pull request instead of a line comment?
      instructions:
      - text: Comment {comments} on pull request {pullRequestId} in {repositoryId}.
        slots:
          comments: requestBody.comments
          pullRequestId: path.pullRequestId
          repositoryId: path.repositoryId
      - text: Add a review thread {comments} at {threadContext} on PR {pullRequestId} in {repositoryId}.
        slots:
          comments: requestBody.comments
          threadContext: requestBody.threadContext
          pullRequestId: path.pullRequestId
          repositoryId: path.repositoryId
      method: generated
      generated: '2026-09-26'