Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian Bitbucket Pullrequests API

37 actions 37 updates phrasing extends openapi/atlassian-pull-requests-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Atlassian's API. It is a proposal applied on top of the contract, not a document Atlassian publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 37 · first 16 shown; the file carries all of them

$.info
$.paths['/pullrequests/{selected_user}'].get
$.paths['/repositories/{workspace}/{repo_slug}/commit/{commit}/pullrequests'].get
$.paths['/repositories/{workspace}/{repo_slug}/default-reviewers'].get
$.paths['/repositories/{workspace}/{repo_slug}/default-reviewers/{target_username}'].get
$.paths['/repositories/{workspace}/{repo_slug}/default-reviewers/{target_username}'].put
$.paths['/repositories/{workspace}/{repo_slug}/default-reviewers/{target_username}'].delete
$.paths['/repositories/{workspace}/{repo_slug}/effective-default-reviewers'].get
$.paths['/repositories/{workspace}/{repo_slug}/pullrequests'].get
$.paths['/repositories/{workspace}/{repo_slug}/pullrequests'].post
$.paths['/repositories/{workspace}/{repo_slug}/pullrequests/activity'].get
$.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}'].get
$.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}'].put
$.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/activity'].get
$.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/approve'].post
$.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/approve'].delete

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 Atlassian Bitbucket Pullrequests API
  version: 1.0.0
extends: openapi/atlassian-pull-requests-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 36
- target: $.paths['/pullrequests/{selected_user}'].get
  update:
    x-apievangelist-phrasing:
      intent: List pull requests authored by a user
      effect: read
      questions:
      - Can I see every pull request a particular teammate has opened across Bitbucket?
      - Which pull requests has a given user authored, including merged or declined ones?
      instructions:
      - text: List the open pull requests authored by {selected_user}.
        slots:
          selected_user: path.selected_user
      - text: Show pull requests by {selected_user} that are in state {state}.
        slots:
          selected_user: path.selected_user
          state: query.state
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/commit/{commit}/pullrequests'].get
  update:
    x-apievangelist-phrasing:
      intent: Find the pull requests that contain a commit
      effect: read
      questions:
      - Which pull request was this commit reviewed in?
      - Is there a way to trace a commit hash back to the pull requests that included it?
      instructions:
      - text: Find the pull requests containing commit {commit} in {workspace}/{repo_slug}.
        slots:
          commit: path.commit
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: List pull requests that reviewed commit {commit} in repo {repo_slug}, {pagelen} per page.
        slots:
          commit: path.commit
          repo_slug: path.repo_slug
          pagelen: query.pagelen
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/default-reviewers'].get
  update:
    x-apievangelist-phrasing:
      intent: List a repository's default reviewers
      effect: read
      questions:
      - Who gets added automatically as a reviewer on new pull requests in this repo?
      - What are the repository-level default reviewers, not counting ones inherited from the project?
      instructions:
      - text: List the default reviewers set on repository {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show who is configured as a default reviewer directly on {repo_slug}.
        slots:
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/default-reviewers/{target_username}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether a user is a default reviewer
      effect: read
      questions:
      - Is a specific person already on the default reviewers list for my repository?
      - Can I test whether one user is a default reviewer without fetching the whole list?
      instructions:
      - text: Check if {target_username} is a default reviewer on {workspace}/{repo_slug}.
        slots:
          target_username: path.target_username
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Get default reviewer {target_username} from repo {repo_slug}.
        slots:
          target_username: path.target_username
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/default-reviewers/{target_username}'].put
  update:
    x-apievangelist-phrasing:
      intent: Add a user to a repo's default reviewers
      effect: write
      questions:
      - How do I make someone a default reviewer so they're added to every new pull request?
      - What happens if I add the same default reviewer twice?
      instructions:
      - text: Add {target_username} to the default reviewers of {workspace}/{repo_slug}.
        slots:
          target_username: path.target_username
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Make {target_username} an automatic reviewer on new pull requests in {repo_slug}.
        slots:
          target_username: path.target_username
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/default-reviewers/{target_username}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user from a repo's default reviewers
      effect: destructive
      questions:
      - Can I stop someone from being auto-added as a reviewer on this repository's pull requests?
      - How do I take a person off the default reviewers list?
      instructions:
      - text: Remove {target_username} from the default reviewers of {workspace}/{repo_slug}.
        slots:
          target_username: path.target_username
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Stop auto-adding {target_username} as a reviewer in {repo_slug}.
        slots:
          target_username: path.target_username
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/effective-default-reviewers'].get
  update:
    x-apievangelist-phrasing:
      intent: List effective default reviewers incl. project
      effect: read
      questions:
      - Which default reviewers actually apply to my repo once project-level reviewers are included?
      - Can I see default reviewers inherited from the parent project as well as the repository's own?
      instructions:
      - text: List the effective default reviewers, including inherited project ones, for {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show everyone who will be auto-added to new pull requests in {repo_slug}, project-inherited included.
        slots:
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests'].get
  update:
    x-apievangelist-phrasing:
      intent: List pull requests on a repository
      effect: read
      questions:
      - What pull requests are currently open in this Bitbucket repository?
      - Can I list a repo's merged or declined pull requests instead of only open ones?
      instructions:
      - text: List open pull requests in {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show the {state} pull requests in repository {repo_slug}.
        slots:
          state: query.state
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests'].post
  update:
    x-apievangelist-phrasing:
      intent: Open a new pull request
      effect: write
      questions:
      - How do I open a pull request from a feature branch into main?
      - What's the minimum I need to supply to create a pull request?
      - Can I add reviewers and close the source branch when I create a pull request?
      instructions:
      - text: Open a pull request titled {title} from {source} in {workspace}/{repo_slug}.
        slots:
          title: requestBody.title
          source: requestBody.source
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Create a pull request in {repo_slug} from {source} into {destination} with reviewers {reviewers}.
        slots:
          repo_slug: path.repo_slug
          source: requestBody.source
          destination: requestBody.destination
          reviewers: requestBody.reviewers
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/activity'].get
  update:
    x-apievangelist-phrasing:
      intent: List activity across all pull requests in a repo
      effect: read
      questions:
      - What review activity has happened across all pull requests in this repository?
      - Can I get one feed of comments, approvals and updates for every pull request in a repo?
      instructions:
      - text: Show the combined pull request activity feed for repository {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: List recent comments, approvals and updates across every pull request in {repo_slug}.
        slots:
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pull request
      effect: read
      questions:
      - What's the current status, branches and reviewers of a specific pull request?
      - Can I pull up the details of a single pull request by its number?
      instructions:
      - text: 'Get pull request #{pull_request_id} in {workspace}/{repo_slug}.'
        slots:
          pull_request_id: path.pull_request_id
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show me the details of PR {pull_request_id} in {repo_slug}.
        slots:
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a pull request's title, branches or description
      effect: write
      questions:
      - How do I change the title or description of an open pull request?
      - Can I retarget an existing pull request to a different destination branch?
      - Is it possible to edit a pull request after it has been merged?
      instructions:
      - text: 'Rename pull request #{pull_request_id} in {workspace}/{repo_slug} to {title}.'
        slots:
          pull_request_id: path.pull_request_id
          workspace: path.workspace
          repo_slug: path.repo_slug
          title: requestBody.title
      - text: Change the destination branch of PR {pull_request_id} in {repo_slug} to {destination}.
        slots:
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
          destination: requestBody.destination
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/activity'].get
  update:
    x-apievangelist-phrasing:
      intent: List the activity log of one pull request
      effect: read
      questions:
      - What's the history of comments, approvals and updates on one specific pull request?
      - Who approved or requested changes on this pull request, and when?
      instructions:
      - text: 'Show the activity log for pull request #{pull_request_id} in {workspace}/{repo_slug}.'
        slots:
          pull_request_id: path.pull_request_id
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: List the review timeline of PR {pull_request_id} in {repo_slug}.
        slots:
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/approve'].post
  update:
    x-apievangelist-phrasing:
      intent: Approve a pull request
      effect: write
      questions:
      - How do I approve a pull request as myself through the API?
      - Can an approval be recorded on a pull request without merging it?
      instructions:
      - text: 'Approve pull request #{pull_request_id} in {workspace}/{repo_slug}.'
        slots:
          pull_request_id: path.pull_request_id
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Give my approval to PR {pull_request_id} in {repo_slug}.
        slots:
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/approve'].delete
  update:
    x-apievangelist-phrasing:
      intent: Withdraw my approval of a pull request
      effect: destructive
      questions:
      - I approved a pull request by mistake — can I take my approval back?
      - Is there a way to redact my approval on a pull request?
      instructions:
      - text: 'Withdraw my approval of pull request #{pull_request_id} in {workspace}/{repo_slug}.'
        slots:
          pull_request_id: path.pull_request_id
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Unapprove PR {pull_request_id} in {repo_slug}.
        slots:
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on a pull request
      effect: read
      questions:
      - What feedback has been left on a pull request, including inline comments and replies?
      - In what order are pull request comments returned?
      instructions:
      - text: 'List all comments on pull request #{pull_request_id} in {workspace}/{repo_slug}.'
        slots:
          pull_request_id: path.pull_request_id
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show the inline and general comments on PR {pull_request_id} in {repo_slug}.
        slots:
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments'].post
  update:
    x-apievangelist-phrasing:
      intent: Comment on a pull request
      effect: write
      questions:
      - How do I post a review comment on a pull request?
      - Can I leave a comment as pending so it isn't published right away?
      instructions:
      - text: 'Post a new comment on pull request #{pull_request_id} in {workspace}/{repo_slug}.'
        slots:
          pull_request_id: path.pull_request_id
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: 'Add a pending comment to PR {pull_request_id} in {repo_slug}: pending {pending}.'
        slots:
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
          pending: requestBody.pending
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one comment on a pull request
      effect: read
      questions:
      - Can I fetch a single pull request comment by its ID?
      - Is a particular review comment resolved or still pending?
      instructions:
      - text: 'Get comment {comment_id} on pull request #{pull_request_id} in {workspace}/{repo_slug}.'
        slots:
          comment_id: path.comment_id
          pull_request_id: path.pull_request_id
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show me PR comment {comment_id} from pull request {pull_request_id} in {repo_slug}.
        slots:
          comment_id: path.comment_id
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a comment on a pull request
      effect: write
      questions:
      - How do I edit a review comment I already posted on a pull request?
      - Can I publish a pending pull request comment by updating it?
      instructions:
      - text: 'Edit comment {comment_id} on pull request #{pull_request_id} in {workspace}/{repo_slug}.'
        slots:
          comment_id: path.comment_id
          pull_request_id: path.pull_request_id
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Set pending to {pending} on comment {comment_id} of PR {pull_request_id} in {repo_slug}.
        slots:
          pending: requestBody.pending
          comment_id: path.comment_id
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment on a pull request
      effect: destructive
      questions:
      - Can I delete a comment I left on a pull request?
      - How do I remove an outdated review comment from a PR?
      instructions:
      - text: 'Delete comment {comment_id} from pull request #{pull_request_id} in {workspace}/{repo_slug}.'
        slots:
          comment_id: path.comment_id
          pull_request_id: path.pull_request_id
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Remove PR comment {comment_id} on pull request {pull_request_id} in {repo_slug}.
        slots:
          comment_id: path.comment_id
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id}/resolve'].post
  update:
    x-apievangelist-phrasing:
      intent: Resolve a pull request comment thread
      effect: write
      questions:
      - How do I mark a review conversation on a pull request as resolved?
      - Can a comment thread be resolved through the API once the feedback is addressed?
      instructions:
      - text: 'Resolve the comment thread {comment_id} on pull request #{pull_request_id} in {workspace}/{repo_slug}.'
        slots:
          comment_id: path.comment_id
          pull_request_id: path.pull_request_id
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Mark thread {comment_id} on PR {pull_request_id} in {repo_slug} as resolved.
        slots:
          comment_id: path.comment_id
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id}/resolve'].delete
  update:
    x-apievangelist-phrasing:
      intent: Reopen a resolved pull request comment thread
      effect: destructive
      questions:
      - A review thread was resolved too early — can I reopen it?
      - Is there a way to unresolve a comment thread on a pull request?
      instructions:
      - text: 'Reopen resolved comment thread {comment_id} on pull request #{pull_request_id} in {workspace}/{repo_slug}.'
        slots:
          comment_id: path.comment_id
          pull_request_id: path.pull_request_id
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Unresolve thread {comment_id} on PR {pull_request_id} in {repo_slug}.
        slots:
          comment_id: path.comment_id
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/commits'].get
  update:
    x-apievangelist-phrasing:
      intent: List the commits in a pull request
      effect: read
      questions:
      - Which commits will land on the destination branch if this pull request is merged?
      - Can I see the commit list for a pull request?
      instructions:
      - text: 'List the commits in pull request #{pull_request_id} in {workspace}/{repo_slug}.'
        slots:
          pull_request_id: path.pull_request_id
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show which commits PR {pull_request_id} in {repo_slug} would merge.
        slots:
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/decline'].post
  update:
    x-apievangelist-phrasing:
      intent: Decline a pull request
      effect: destructive
      questions:
      - How do I reject a pull request we're not going to merge?
      - Can I close out a pull request as declined from a script?
      instructions:
      - text: 'Decline pull request #{pull_request_id} in {workspace}/{repo_slug}.'
        slots:
          pull_request_id: path.pull_request_id
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Reject PR {pull_request_id} in {repo_slug} without merging.
        slots:
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/diff'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the diff of a pull request
      effect: read
      questions:
      - Can I get the full line-by-line diff of what a pull request changes?
      - Where do I fetch the code changes introduced by a pull request?
      instructions:
      - text: 'Get the diff for pull request #{pull_request_id} in {workspace}/{repo_slug}.'
        slots:
          pull_request_id: path.pull_request_id
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show the code changes in PR {pull_request_id} of {repo_slug} as a diff.
        slots:
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/diffstat'].get
  update:
    x-apievangelist-phrasing:
      intent: Get file change stats for a pull request
      effect: read
      questions:
      - Which files does a pull request touch and how many lines were added or removed?
      - Can I get a summary of changed files for a PR rather than the full diff?
      instructions:
      - text: 'Get the diffstat for pull request #{pull_request_id} in {workspace}/{repo_slug}.'
        slots:
          pull_request_id: path.pull_request_id
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Summarize which files changed and lines added or removed in PR {pull_request_id} of {repo_slug}.
        slots:
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/merge'].post
  update:
    x-apievangelist-phrasing:
      intent: Merge a pull request
      effect: write
      questions:
      - How do I merge an approved pull request through the API?
      - Can I pick a squash or fast-forward merge strategy and close the source branch when merging?
      - What if a merge takes too long — can it run asynchronously?
      instructions:
      - text: 'Merge pull request #{pull_request_id} in {workspace}/{repo_slug}.'
        slots:
          pull_request_id: path.pull_request_id
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Merge PR {pull_request_id} in {repo_slug} using the {merge_strategy} strategy with message {message}.
        slots:
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
          merge_strategy: requestBody.merge_strategy
          message: requestBody.message
      - text: 'Merge PR {pull_request_id} in {repo_slug} and close the source branch: {close_source_branch}.'
        slots:
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
          close_source_branch: requestBody.close_source_branch
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/merge/task-status/{task_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a pending merge task
      effect: read
      questions:
      - My merge returned a task ID with a 202 — how can I tell when it finishes?
      - Has a long-running pull request merge completed yet?
      instructions:
      - text: 'Check merge task {task_id} for pull request #{pull_request_id} in {workspace}/{repo_slug}.'
        slots:
          task_id: path.task_id
          pull_request_id: path.pull_request_id
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Poll the status of async merge {task_id} on PR {pull_request_id} in {repo_slug}.
        slots:
          task_id: path.task_id
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/patch'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pull request as a patch
      effect: read
      questions:
      - Can I download a pull request as a git patch I can apply elsewhere?
      - Where do I get the patch file for a PR?
      instructions:
      - text: 'Get the patch for pull request #{pull_request_id} in {workspace}/{repo_slug}.'
        slots:
          pull_request_id: path.pull_request_id
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Export PR {pull_request_id} from {repo_slug} as a patch file.
        slots:
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/request-changes'].post
  update:
    x-apievangelist-phrasing:
      intent: Request changes on a pull request
      effect: write
      questions:
      - How do I flag a pull request as needing changes before it can merge?
      - Can I mark a PR as 'changes requested' as a reviewer?
      instructions:
      - text: 'Request changes on pull request #{pull_request_id} in {workspace}/{repo_slug}.'
        slots:
          pull_request_id: path.pull_request_id
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Mark PR {pull_request_id} in {repo_slug} as needing changes.
        slots:
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/request-changes'].delete
  update:
    x-apievangelist-phrasing:
      intent: Withdraw my change request on a pull request
      effect: destructive
      questions:
      - The author fixed my concerns — can I clear my 'changes requested' status?
      - Is there a way to remove a change request I placed on a PR?
      instructions:
      - text: 'Remove my change request from pull request #{pull_request_id} in {workspace}/{repo_slug}.'
        slots:
          pull_request_id: path.pull_request_id
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Clear the changes-requested status I set on PR {pull_request_id} in {repo_slug}.
        slots:
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/tasks'].get
  update:
    x-apievangelist-phrasing:
      intent: List tasks on a pull request
      effect: read
      questions:
      - What to-do tasks are still open on a pull request?
      - Can I filter and sort pull request tasks, for example only unresolved ones?
      instructions:
      - text: 'List the tasks on pull request #{pull_request_id} in {workspace}/{repo_slug}.'
        slots:
          pull_request_id: path.pull_request_id
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show tasks on PR {pull_request_id} in {repo_slug} matching {q}, sorted by {sort}.
        slots:
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
          q: query.q
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/tasks'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a task to a pull request
      effect: write
      questions:
      - How do I add a to-do item to a pull request?
      - Can I attach a pull request task to a specific review comment?
      instructions:
      - text: 'Add a task {content} to pull request #{pull_request_id} in {workspace}/{repo_slug}.'
        slots:
          content: requestBody.content
          pull_request_id: path.pull_request_id
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Create task {content} on PR {pull_request_id} in {repo_slug} linked to comment {comment}.
        slots:
          content: requestBody.content
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
          comment: requestBody.comment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/tasks/{task_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one task on a pull request
      effect: read
      questions:
      - Is a specific pull request task done or still open?
      - Can I look up a single PR task by its ID?
      instructions:
      - text: 'Get task {task_id} on pull request #{pull_request_id} in {workspace}/{repo_slug}.'
        slots:
          task_id: path.task_id
          pull_request_id: path.pull_request_id
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show PR task {task_id} from pull request {pull_request_id} in {repo_slug}.
        slots:
          task_id: path.task_id
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/tasks/{task_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update or resolve a pull request task
      effect: write
      questions:
      - How do I tick off a task on a pull request as resolved?
      - Can I reword an existing pull request task?
      instructions:
      - text: 'Set task {task_id} on pull request #{pull_request_id} in {workspace}/{repo_slug} to state {state}.'
        slots:
          task_id: path.task_id
          pull_request_id: path.pull_request_id
          workspace: path.workspace
          repo_slug: path.repo_slug
          state: requestBody.state
      - text: Change the text of PR task {task_id} on pull request {pull_request_id} in {repo_slug} to {content}.
        slots:
          task_id: path.task_id
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
          content: requestBody.content
      method: generated
      generated: '2026-10-01'


# --- truncated at 32 KB (32 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/overlays/atlassian-pull-requests-api-phrasing-overlay.yaml