Bitbucket · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bitbucket Pullrequests API

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

What the actions change

x-apievangelist-phrasing

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

$.info
$.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
$.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments'].get

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 Bitbucket Pullrequests API
  version: 1.0.0
extends: openapi/bitbucket-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: 37
- target: $.paths['/repositories/{workspace}/{repo_slug}/commit/{commit}/pullrequests'].get
  update:
    x-apievangelist-phrasing:
      intent: Find pull requests that contain a commit
      effect: read
      questions:
      - Which pull request was this commit reviewed and merged in?
      - Can I trace a commit hash back to the PRs that included it?
      instructions:
      - text: List pull requests containing commit {commit} in {workspace}/{repo_slug}.
        slots:
          commit: path.commit
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Find the PRs where commit {commit} was reviewed, {pagelen} per page.
        slots:
          commit: path.commit
          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 every new pull request in this repo?
      - Which users are set as default reviewers directly on a Bitbucket repository?
      instructions:
      - text: List the default reviewers configured on {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show me who is auto-added to every new PR in repo {repo_slug}, workspace {workspace}.
        slots:
          repo_slug: path.repo_slug
          workspace: path.workspace
      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 teammate already on the default reviewer list for a repo?
      - Can I test one user's default-reviewer membership without pulling the whole list?
      instructions:
      - text: Check whether {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: Confirm user {target_username} is among the default reviewers of repo {repo_slug} in {workspace}.
        slots:
          target_username: path.target_username
          repo_slug: path.repo_slug
          workspace: path.workspace
      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 review every new pull request in a repository automatically?
      - What happens if I add a person to default reviewers who is already on the list?
      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 user {target_username} an automatic reviewer on every new PR in repo {repo_slug}, workspace {workspace}.
        slots:
          target_username: path.target_username
          repo_slug: path.repo_slug
          workspace: path.workspace
      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:
      - How can I stop a person from being auto-added as reviewer on new pull requests?
      - Can I take one user off a repository's default reviewer 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 user {target_username} as reviewer on new PRs in repo {repo_slug}, workspace {workspace}.
        slots:
          target_username: path.target_username
          repo_slug: path.repo_slug
          workspace: path.workspace
      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 apply to a repo once the ones inherited from its project are included?
      - Can I see repository-level and project-inherited default reviewers together?
      instructions:
      - text: List the effective default reviewers, including project-inherited ones, for {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show every inherited and repo-level default reviewer that applies to repo {repo_slug} in {workspace}.
        slots:
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests'].get
  update:
    x-apievangelist-phrasing:
      intent: List a repository's pull requests
      effect: read
      questions:
      - What pull requests are currently open on a Bitbucket repository?
      - Can I list merged or declined PRs in a repo instead of just the open ones?
      instructions:
      - text: List the open pull requests in {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show pull requests in state {state} for repo {repo_slug} in workspace {workspace}.
        slots:
          state: query.state
          repo_slug: path.repo_slug
          workspace: path.workspace
      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 is the minimum I need to supply to create a PR — a title and a source branch?
      - Can I create a pull request as a draft and set reviewers when I open it?
      instructions:
      - text: Open a pull request titled {title} from branch {source} in {workspace}/{repo_slug}.
        slots:
          title: requestBody.title
          source: requestBody.source
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Create a draft PR {title} from {source} into {destination} in repo {repo_slug}, workspace {workspace}, with reviewers {reviewers}.
        slots:
          title: requestBody.title
          source: requestBody.source
          destination: requestBody.destination
          repo_slug: path.repo_slug
          workspace: path.workspace
          reviewers: requestBody.reviewers
      - text: Open PR {title} from {source} and close the source branch after merge in {workspace}/{repo_slug}.
        slots:
          title: requestBody.title
          source: requestBody.source
          workspace: path.workspace
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/activity'].get
  update:
    x-apievangelist-phrasing:
      intent: List activity across a repo's pull requests
      effect: read
      questions:
      - What has happened recently across all the pull requests in a repository?
      - Can I get one activity feed of approvals, comments and updates for every PR in a repo?
      instructions:
      - text: Show the combined pull request activity log for all PRs in {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: List recent activity across every pull request in repo {repo_slug}, workspace {workspace}.
        slots:
          repo_slug: path.repo_slug
          workspace: path.workspace
      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 are the title, branches and state of a particular pull request?
      - Where can I look up a single PR 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 {repo_slug}, workspace {workspace}.
        slots:
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an open pull request
      effect: write
      questions:
      - Can I change the title, description or destination branch of a PR that is still open?
      - Is it possible to edit a pull request after it has been merged?
      instructions:
      - text: 'Change the title of PR #{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: Retarget pull request {pull_request_id} in repo {repo_slug}, workspace {workspace}, onto branch {destination}.
        slots:
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
          workspace: path.workspace
          destination: requestBody.destination
      - text: Rewrite the description of PR {pull_request_id} in {workspace}/{repo_slug} to {summary}.
        slots:
          pull_request_id: path.pull_request_id
          workspace: path.workspace
          repo_slug: path.repo_slug
          summary: requestBody.summary
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/activity'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one pull request's activity log
      effect: read
      questions:
      - What is the history of approvals, comments and updates on a single pull request?
      - When was a specific PR last updated, and by whom?
      instructions:
      - text: 'Show the activity log for PR #{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 timeline of events on pull request {pull_request_id} in repo {repo_slug}, workspace {workspace}.
        slots:
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
          workspace: path.workspace
      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 a bot account give a PR its approval programmatically?
      instructions:
      - text: 'Approve PR #{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 pull request {pull_request_id} in repo {repo_slug}, workspace {workspace}.
        slots:
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
          workspace: path.workspace
      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 PR by mistake — how do I take the approval back?
      - Can I unapprove a pull request after new commits are pushed?
      instructions:
      - text: 'Remove my approval from PR #{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 pull request {pull_request_id} in repo {repo_slug}, workspace {workspace}.
        slots:
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
          workspace: path.workspace
      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 review comments, inline ones included, have been left on a pull request?
      - Can I sort a PR's comment thread newest first?
      instructions:
      - text: 'List all comments on PR #{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 review comments on pull request {pull_request_id} in repo {repo_slug}, workspace {workspace}.
        slots:
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
          workspace: path.workspace
      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 pending comment on a PR that is not published yet?
      instructions:
      - text: 'Add a comment to PR #{pull_request_id} in {workspace}/{repo_slug}.'
        slots:
          pull_request_id: path.pull_request_id
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Post a pending review comment on pull request {pull_request_id} in repo {repo_slug}, workspace {workspace}, setting pending to {pending}.
        slots:
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
          workspace: path.workspace
          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:
      - How can I fetch a single PR review comment by its id?
      - Is a particular comment on a pull request resolved or still pending?
      instructions:
      - text: 'Get comment {comment_id} on PR #{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 review comment {comment_id} from pull request {pull_request_id} in repo {repo_slug}, workspace {workspace}.
        slots:
          comment_id: path.comment_id
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
          workspace: path.workspace
      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:
      - Can I edit a review comment I already posted on a pull request?
      - How do I publish a pending PR comment I left earlier?
      instructions:
      - text: 'Edit comment {comment_id} on PR #{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 pull request {pull_request_id} in repo {repo_slug}, workspace {workspace}.
        slots:
          pending: requestBody.pending
          comment_id: path.comment_id
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
          workspace: path.workspace
      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:
      - How do I remove a review comment from a pull request?
      - Can I delete a PR comment someone posted by mistake?
      instructions:
      - text: 'Delete comment {comment_id} from PR #{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 review comment {comment_id} on pull request {pull_request_id} in repo {repo_slug}, workspace {workspace}.
        slots:
          comment_id: path.comment_id
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
          workspace: path.workspace
      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 PR comment thread
      effect: write
      questions:
      - How do I mark a review discussion on a pull request as resolved?
      - Can I close out a comment thread once the feedback is addressed?
      instructions:
      - text: 'Resolve the comment thread {comment_id} on PR #{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 discussion {comment_id} on pull request {pull_request_id} in repo {repo_slug}, workspace {workspace}, as resolved.
        slots:
          comment_id: path.comment_id
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
          workspace: path.workspace
      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 PR comment thread
      effect: destructive
      questions:
      - A review thread was resolved too early — can I reopen it?
      - How do I un-resolve a comment discussion on a pull request?
      instructions:
      - text: 'Reopen resolved thread {comment_id} on PR #{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: Un-resolve discussion {comment_id} on pull request {pull_request_id} in repo {repo_slug}, workspace {workspace}.
        slots:
          comment_id: path.comment_id
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/commits'].get
  update:
    x-apievangelist-phrasing:
      intent: List commits in a pull request
      effect: read
      questions:
      - Which commits will land on the destination branch when a PR is merged?
      - How many commits does a pull request contain?
      instructions:
      - text: 'List the commits in PR #{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 commits pull request {pull_request_id} would merge in repo {repo_slug}, workspace {workspace}.
        slots:
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
          workspace: path.workspace
      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 without merging it?
      - Can I decline a PR that is no longer needed?
      instructions:
      - text: 'Decline PR #{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 pull request {pull_request_id} in repo {repo_slug}, workspace {workspace}, without merging.
        slots:
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
          workspace: path.workspace
      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:
      - What line-by-line code changes does a pull request introduce?
      - Can I download the raw unified diff for a PR?
      instructions:
      - text: 'Get the diff for PR #{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 line-level code changes in pull request {pull_request_id} in repo {repo_slug}, workspace {workspace}.
        slots:
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/diffstat'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pull request's diffstat
      effect: read
      questions:
      - Which files does a pull request touch, and how many lines are added or removed in each?
      - Is there a per-file summary of a PR's changes rather than the full diff?
      instructions:
      - text: 'Get the diffstat for PR #{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 files changed and lines added or removed in pull request {pull_request_id}, repo {repo_slug}, workspace {workspace}.
        slots:
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
          workspace: path.workspace
      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?
      - Which merge strategies can I choose, such as squash or fast-forward?
      - Can a long-running merge run asynchronously and give me a task to poll?
      instructions:
      - text: 'Merge PR #{pull_request_id} in {workspace}/{repo_slug}.'
        slots:
          pull_request_id: path.pull_request_id
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Squash-merge pull request {pull_request_id} in repo {repo_slug}, workspace {workspace}, using strategy {merge_strategy} and message {message}.
        slots:
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
          workspace: path.workspace
          merge_strategy: requestBody.merge_strategy
          message: requestBody.message
      - text: Merge PR {pull_request_id} in {workspace}/{repo_slug} asynchronously with async {async} and close source branch {close_source_branch}.
        slots:
          pull_request_id: path.pull_request_id
          workspace: path.workspace
          repo_slug: path.repo_slug
          async: query.async
          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 an async PR merge
      effect: read
      questions:
      - My merge returned a 202 with a task id — how do I find out if it finished?
      - Is a slow pull request merge still pending or has it succeeded?
      instructions:
      - text: 'Check merge task {task_id} for PR #{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 whether the async merge {task_id} of pull request {pull_request_id} in repo {repo_slug}, workspace {workspace}, is done.
        slots:
          task_id: path.task_id
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
          workspace: path.workspace
      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 export a pull request as a git patch file to apply elsewhere?
      - Is there a patch-formatted version of a PR with commit metadata?
      instructions:
      - text: 'Get the patch for PR #{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 pull request {pull_request_id} from repo {repo_slug}, workspace {workspace}, as a git patch.
        slots:
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
          workspace: path.workspace
      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 that a pull request needs changes before it can merge?
      - Can a reviewer block a PR by requesting changes via the API?
      instructions:
      - text: 'Request changes on PR #{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 pull request {pull_request_id} in repo {repo_slug}, workspace {workspace}, as needing changes.
        slots:
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
          workspace: path.workspace
      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 a change request on a PR
      effect: destructive
      questions:
      - The author fixed my feedback — how do I clear my request for changes?
      - Can I remove a changes-requested status I put on a pull request?
      instructions:
      - text: 'Withdraw my change request on PR #{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 flag I set on pull request {pull_request_id} in repo {repo_slug}, workspace {workspace}.
        slots:
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/statuses'].get
  update:
    x-apievangelist-phrasing:
      intent: List build statuses for a pull request
      effect: read
      questions:
      - Did the CI builds pass for a pull request?
      - Can I filter a PR's build results to only failed ones?
      instructions:
      - text: 'List build statuses for PR #{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 build results for pull request {pull_request_id} in repo {repo_slug}, workspace {workspace}, filtered by {q}.
        slots:
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
          workspace: path.workspace
          q: query.q
      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 a PR's checklist tasks by state?
      instructions:
      - text: 'List the tasks on PR #{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 pull request {pull_request_id} in repo {repo_slug}, workspace {workspace}, matching {q}.
        slots:
          pull_request_id: path.pull_request_id
          repo_slug: path.repo_slug
          workspace: path.workspace
          q: query.q
      method: generated
      generated: '2026-10-01'


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