Harness · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Harness Pullreq API
53 actions
53 updates
phrasing
extends
openapi/harness-pullreq-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Harness's API. It is a proposal applied on top of the contract, not a document Harness publishes.
What the actions change
x-apievangelist-phrasing
Targets 53 · first 16 shown; the file carries all of them
$.info
$.paths['/code/api/v1/pullreq'].get
$.paths['/code/api/v1/pullreq/count'].get
$.paths['/code/api/v1/repos/{repo_identifier}/pullreq'].get
$.paths['/code/api/v1/repos/{repo_identifier}/pullreq'].post
$.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}'].get
$.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}'].patch
$.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/activities'].get
$.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/automerge'].get
$.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/automerge'].put
$.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/automerge'].delete
$.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/branch'].post
$.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/checks'].get
$.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/codeowners'].get
$.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/comments'].post
$.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/comments/{pullreq_comment_id}'].delete
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Harness Pullreq API
version: 1.0.0
extends: openapi/harness-pullreq-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: 52
- target: $.paths['/code/api/v1/pullreq'].get
update:
x-apievangelist-phrasing:
intent: List pull requests across an account, org or project
effect: read
questions:
- Can I see every open pull request across all repos in my Harness project at once?
- Which pull requests across my whole org are waiting on my review?
instructions:
- text: List all open pull requests across every repo in account {account}.
slots:
account: query.accountIdentifier
- text: Show pull requests across all repos in project {project} that target branch {target_branch}.
slots:
project: query.projectIdentifier
target_branch: query.target_branch
method: generated
generated: '2026-09-26'
- target: $.paths['/code/api/v1/pullreq/count'].get
update:
x-apievangelist-phrasing:
intent: Count pull requests across an account, org or project
effect: read
questions:
- How many pull requests are open across all repositories in my project?
- What's the total number of merged PRs in my org, without listing them?
instructions:
- text: Count the pull requests in state {state} across all repos in account {account}.
slots:
state: query.state
account: query.accountIdentifier
- text: Give me a count of PRs authored by {author_id} across the whole org.
slots:
author_id: query.author_id
method: generated
generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq'].get
update:
x-apievangelist-phrasing:
intent: List pull requests in a repository
effect: read
questions:
- What pull requests are open in one specific Harness Code repository?
- Can I sort a single repo's pull requests by when they were last updated?
instructions:
- text: List the open pull requests in repo {repo_identifier}.
slots:
repo_identifier: path.repo_identifier
- text: Show pull requests in repo {repo_identifier} coming from branch {source_branch}.
slots:
repo_identifier: path.repo_identifier
source_branch: query.source_branch
method: generated
generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq'].post
update:
x-apievangelist-phrasing:
intent: Open a pull request
effect: write
questions:
- How do I open a pull request from a feature branch into main?
- Can I open a PR as a draft and assign reviewers in the same step?
instructions:
- text: Open a pull request in repo {repo_identifier} from {source_branch} into {target_branch} titled {title}.
slots:
repo_identifier: path.repo_identifier
source_branch: requestBody.source_branch
target_branch: requestBody.target_branch
title: requestBody.title
- text: Create a draft PR in {repo_identifier} from branch {source_branch} with reviewers {reviewer_ids}.
slots:
repo_identifier: path.repo_identifier
source_branch: requestBody.source_branch
reviewer_ids: requestBody.reviewer_ids
method: generated
generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}'].get
update:
x-apievangelist-phrasing:
intent: Get a pull request
effect: read
questions:
- Where can I look up the title, branches and state of one pull request by its number?
- Is pull request number 42 still open or already merged?
instructions:
- text: 'Fetch pull request #{pullreq_number} in repo {repo_identifier}.'
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
- text: Show me the details of PR {pullreq_number} in {repo_identifier}.
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
method: generated
generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}'].patch
update:
x-apievangelist-phrasing:
intent: Edit a pull request's title or description
effect: write
questions:
- Can I rename a pull request after it's been opened?
- How do I rewrite the description on an existing PR?
instructions:
- text: 'Change the title of PR #{pullreq_number} in {repo_identifier} to {title}.'
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
title: requestBody.title
- text: Replace the description of pull request {pullreq_number} in repo {repo_identifier} with {description}.
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
description: requestBody.description
method: generated
generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/activities'].get
update:
x-apievangelist-phrasing:
intent: List a pull request's activity timeline
effect: read
questions:
- What has happened on a pull request so far, comments, reviews and state changes included?
- Can I filter a PR's activity feed to only one kind of event?
instructions:
- text: 'Show the activity timeline for PR #{pullreq_number} in {repo_identifier}.'
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
- text: List activities of kind {kind} on pull request {pullreq_number} in repo {repo_identifier}.
slots:
kind: query.kind
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
method: generated
generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/automerge'].get
update:
x-apievangelist-phrasing:
intent: Check a pull request's auto-merge setting
effect: read
questions:
- Is auto-merge turned on for this pull request?
- Which merge method will auto-merge use once my PR's checks pass?
instructions:
- text: 'Tell me whether auto-merge is enabled on PR #{pullreq_number} in {repo_identifier}.'
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
- text: Get the auto-merge options for pull request {pullreq_number} in repo {repo_identifier}.
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
method: generated
generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/automerge'].put
update:
x-apievangelist-phrasing:
intent: Turn on auto-merge for a pull request
effect: write
questions:
- Can a pull request merge itself automatically once it's ready?
- Can auto-merge delete the source branch after it merges my PR?
instructions:
- text: 'Enable auto-merge on PR #{pullreq_number} in {repo_identifier} using the {method} method.'
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
method: requestBody.method
- text: Set pull request {pullreq_number} in repo {repo_identifier} to auto-merge and delete its source branch afterwards.
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
method: generated
generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/automerge'].delete
update:
x-apievangelist-phrasing:
intent: Turn off auto-merge for a pull request
effect: destructive
questions:
- How do I stop a pull request from merging automatically?
- Can I cancel auto-merge on a PR without closing it?
instructions:
- text: 'Disable auto-merge on PR #{pullreq_number} in {repo_identifier}.'
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
- text: Cancel the pending auto-merge for pull request {pullreq_number} in repo {repo_identifier}.
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
method: generated
generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/branch'].post
update:
x-apievangelist-phrasing:
intent: Restore a pull request's deleted source branch
effect: write
questions:
- The source branch of my PR was deleted after merge; can I bring it back?
- Is there a dry run to see if restoring a PR's branch would break protection rules?
instructions:
- text: 'Restore the source branch of PR #{pullreq_number} in {repo_identifier}.'
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
- text: Dry-run restoring the deleted source branch for pull request {pullreq_number} in repo {repo_identifier}.
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
method: generated
generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/checks'].get
update:
x-apievangelist-phrasing:
intent: Get a pull request's status checks
effect: read
questions:
- Have the CI status checks on my pull request passed?
- Which checks are failing and blocking this PR?
instructions:
- text: 'Show the status checks for PR #{pullreq_number} in {repo_identifier}.'
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
- text: List failing checks on pull request {pullreq_number} in repo {repo_identifier}.
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
method: generated
generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/codeowners'].get
update:
x-apievangelist-phrasing:
intent: Get code owners for a pull request
effect: read
questions:
- Who are the code owners for the files changed in this pull request?
- Does my PR still need approval from a CODEOWNERS entry?
instructions:
- text: 'Show the code owners for PR #{pullreq_number} in {repo_identifier}.'
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
- text: Find which code owners must sign off on pull request {pullreq_number} in repo {repo_identifier}.
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
method: generated
generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/comments'].post
update:
x-apievangelist-phrasing:
intent: Comment on a pull request
effect: write
questions:
- Can I leave a comment on a specific line of a file in a pull request?
- How do I reply to an existing comment thread on a PR?
instructions:
- text: 'Post the comment {text} on PR #{pullreq_number} in {repo_identifier}.'
slots:
text: requestBody.text
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
- text: Add a code comment {text} on {path} line {line_start} of pull request {pullreq_number} in {repo_identifier}.
slots:
text: requestBody.text
path: requestBody.path
line_start: requestBody.line_start
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
method: generated
generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/comments/{pullreq_comment_id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a pull request comment
effect: destructive
questions:
- Can I remove a comment I posted on a pull request?
- What happens to a PR comment once I delete it?
instructions:
- text: 'Delete comment {pullreq_comment_id} on PR #{pullreq_number} in {repo_identifier}.'
slots:
pullreq_comment_id: path.pullreq_comment_id
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
- text: Remove my comment {pullreq_comment_id} from pull request {pullreq_number} in repo {repo_identifier}.
slots:
pullreq_comment_id: path.pullreq_comment_id
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
method: generated
generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/comments/{pullreq_comment_id}'].patch
update:
x-apievangelist-phrasing:
intent: Edit a pull request comment
effect: write
questions:
- Can I fix a typo in a comment I already left on a PR?
- Is it possible to change the text of an existing review comment?
instructions:
- text: 'Change the text of comment {pullreq_comment_id} on PR #{pullreq_number} in {repo_identifier} to {text}.'
slots:
pullreq_comment_id: path.pullreq_comment_id
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
text: requestBody.text
- text: Edit my comment {pullreq_comment_id} on pull request {pullreq_number} in repo {repo_identifier}.
slots:
pullreq_comment_id: path.pullreq_comment_id
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
method: generated
generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/comments/{pullreq_comment_id}/reactions/{pullreq_reaction_emoji}'].post
update:
x-apievangelist-phrasing:
intent: React to a pull request comment with an emoji
effect: write
questions:
- Can I add a thumbs-up emoji to someone's comment on a pull request?
- Which emoji reactions can I put on a PR comment?
instructions:
- text: 'React with {pullreq_reaction_emoji} to comment {pullreq_comment_id} on PR #{pullreq_number} in {repo_identifier}.'
slots:
pullreq_reaction_emoji: path.pullreq_reaction_emoji
pullreq_comment_id: path.pullreq_comment_id
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
- text: Add a {pullreq_reaction_emoji} reaction to comment {pullreq_comment_id} in pull request {pullreq_number} of repo {repo_identifier}.
slots:
pullreq_reaction_emoji: path.pullreq_reaction_emoji
pullreq_comment_id: path.pullreq_comment_id
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
method: generated
generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/comments/{pullreq_comment_id}/reactions/{pullreq_reaction_emoji}'].delete
update:
x-apievangelist-phrasing:
intent: Remove an emoji reaction from a PR comment
effect: destructive
questions:
- How do I take back an emoji reaction I added to a pull request comment?
- Can I undo a reaction on a PR comment?
instructions:
- text: 'Remove my {pullreq_reaction_emoji} reaction from comment {pullreq_comment_id} on PR #{pullreq_number} in {repo_identifier}.'
slots:
pullreq_reaction_emoji: path.pullreq_reaction_emoji
pullreq_comment_id: path.pullreq_comment_id
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
- text: Undo the {pullreq_reaction_emoji} emoji on comment {pullreq_comment_id} in pull request {pullreq_number} of repo {repo_identifier}.
slots:
pullreq_reaction_emoji: path.pullreq_reaction_emoji
pullreq_comment_id: path.pullreq_comment_id
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
method: generated
generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/comments/{pullreq_comment_id}/status'].put
update:
x-apievangelist-phrasing:
intent: Resolve or reopen a pull request comment
effect: write
questions:
- Can I mark a review comment thread as resolved?
- Is there a way to reopen a PR comment that was resolved too early?
instructions:
- text: 'Mark comment {pullreq_comment_id} on PR #{pullreq_number} in {repo_identifier} as resolved.'
slots:
pullreq_comment_id: path.pullreq_comment_id
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
- text: Set the status of comment {pullreq_comment_id} on pull request {pullreq_number} in repo {repo_identifier} to {status}.
slots:
pullreq_comment_id: path.pullreq_comment_id
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
status: requestBody.status
method: generated
generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/comments/apply-suggestions'].post
update:
x-apievangelist-phrasing:
intent: Apply code suggestions from PR comments
effect: write
questions:
- Can I commit the code suggestions reviewers left in comments straight to my PR branch?
- How do I accept several suggested changes on a pull request in one commit?
instructions:
- text: 'Apply the suggested code changes {suggestions} to PR #{pullreq_number} in {repo_identifier}.'
slots:
suggestions: requestBody.suggestions
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
- text: Commit the review suggestions on pull request {pullreq_number} in repo {repo_identifier} with message {message}.
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
message: requestBody.message
method: generated
generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/commits'].get
update:
x-apievangelist-phrasing:
intent: List the commits in a pull request
effect: read
questions:
- Which commits are included in this pull request?
- How many commits has the author pushed to a PR?
instructions:
- text: 'List the commits on PR #{pullreq_number} in {repo_identifier}.'
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
- text: Show the commit history of pull request {pullreq_number} in repo {repo_identifier}.
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
method: generated
generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/diff'].get
update:
x-apievangelist-phrasing:
intent: Get a pull request's file changes
effect: read
questions:
- What files and lines did this pull request change?
- Can I see the diff of just one file path within a PR?
instructions:
- text: 'Show the diff for PR #{pullreq_number} in {repo_identifier}.'
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
- text: Get the changes to file {path} in pull request {pullreq_number} of repo {repo_identifier}.
slots:
path: query.path
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
method: generated
generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/diff'].post
update:
x-apievangelist-phrasing:
intent: Get a pull request's file changes via POST
effect: read
questions:
- Is there a POST form of the pull request diff endpoint for large file lists?
- Can I fetch a PR's file changes with a POST request instead of a GET?
instructions:
- text: 'Fetch the file changes of PR #{pullreq_number} in {repo_identifier} using the POST diff endpoint.'
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
- text: Use the POST variant to retrieve the diff of pull request {pullreq_number} in repo {repo_identifier}.
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
method: generated
generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/file-views'].get
update:
x-apievangelist-phrasing:
intent: List files I've marked as viewed in a PR
effect: read
questions:
- Which files in this pull request have I already marked as viewed?
- How far through reviewing a PR's files am I?
instructions:
- text: 'List the files I''ve marked viewed on PR #{pullreq_number} in {repo_identifier}.'
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
- text: Show my viewed-file progress for pull request {pullreq_number} in repo {repo_identifier}.
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
method: generated
generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/file-views'].put
update:
x-apievangelist-phrasing:
intent: Mark a pull request file as viewed
effect: write
questions:
- Can I tick off a file as reviewed while going through a pull request?
- Does marking a PR file viewed track which commit I reviewed it at?
instructions:
- text: 'Mark file {path} as viewed on PR #{pullreq_number} in {repo_identifier}.'
slots:
path: requestBody.path
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
- text: Record {path} as reviewed at commit {commit_sha} in pull request {pullreq_number} of repo {repo_identifier}.
slots:
path: requestBody.path
commit_sha: requestBody.commit_sha
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
method: generated
generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/file-views/{file_path}'].delete
update:
x-apievangelist-phrasing:
intent: Unmark a pull request file as viewed
effect: destructive
questions:
- How do I unmark a file I flagged as viewed in a PR so it shows up again?
- Can I reset the viewed state of one file in a pull request?
instructions:
- text: 'Unmark {file_path} as viewed on PR #{pullreq_number} in {repo_identifier}.'
slots:
file_path: path.file_path
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
- text: Clear the viewed flag on file {file_path} in pull request {pullreq_number} of repo {repo_identifier}.
slots:
file_path: path.file_path
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
method: generated
generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/merge'].post
update:
x-apievangelist-phrasing:
intent: Merge a pull request
effect: write
questions:
- How do I merge a pull request right now with a squash or rebase?
- Can I dry-run a merge to see if a PR is mergeable before doing it?
- Can an admin bypass branch protection rules when merging a PR?
instructions:
- text: 'Merge PR #{pullreq_number} in {repo_identifier} using the {method} method.'
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
method: requestBody.method
- text: Do a dry-run merge of pull request {pullreq_number} in repo {repo_identifier} and tell me if it would succeed.
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
method: generated
generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/mergequeue'].get
update:
x-apievangelist-phrasing:
intent: Get a pull request's merge queue status
effect: read
questions:
- Where is my pull request sitting in the merge queue?
- Is this PR currently queued to merge into its target branch?
instructions:
- text: 'Show the merge-queue details for PR #{pullreq_number} in {repo_identifier}.'
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
- text: Check the merge queue position of pull request {pullreq_number} in repo {repo_identifier}.
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
method: generated
generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/mergequeue'].put
update:
x-apievangelist-phrasing:
intent: Add a pull request to the merge queue
effect: write
questions:
- How do I put a pull request into the target branch's merge queue?
- Can a queued PR delete its source branch once the queue merges it?
instructions:
- text: 'Add PR #{pullreq_number} in {repo_identifier} to the merge queue.'
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
- text: Queue pull request {pullreq_number} in repo {repo_identifier} for merge with the {method} method.
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
method: requestBody.method
method: generated
generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/mergequeue'].delete
update:
x-apievangelist-phrasing:
intent: Remove a pull request from the merge queue
effect: destructive
questions:
- Can I pull a PR back out of the merge queue before it merges?
- What do I do if I queued the wrong pull request for merge?
instructions:
- text: 'Remove PR #{pullreq_number} in {repo_identifier} from the merge queue.'
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
- text: Dequeue pull request {pullreq_number} in repo {repo_identifier}.
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
method: generated
generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/mergequeue/prioritize'].post
update:
x-apievangelist-phrasing:
intent: Move a pull request to the head of the merge queue
effect: write
questions:
- Can I jump an urgent hotfix PR to the front of the merge queue?
- Is there a way to prioritize one queued pull request over the others?
instructions:
- text: 'Move PR #{pullreq_number} in {repo_identifier} to the head of the merge queue.'
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
- text: Prioritize pull request {pullreq_number} in repo {repo_identifier} so it merges next.
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
method: generated
generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/metadata'].get
update:
x-apievangelist-phrasing:
intent: Get a pull request's metadata
effect: read
questions:
- Is there a lightweight way to get just the metadata of a pull request?
- Can I fetch a PR's metadata without loading its full diff or comments?
instructions:
- text: 'Get the metadata for PR #{pullreq_number} in {repo_identifier}.'
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
- text: Pull only the metadata record of pull request {pullreq_number} in repo {repo_identifier}.
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
method: generated
generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/revert'].post
update:
x-apievangelist-phrasing:
intent: Revert a merged pull request
effect: write
questions:
- A merged PR broke production; how do I revert it?
- Can I choose the branch name that the revert of a merged pull request goes on?
instructions:
- text: 'Revert merged PR #{pullreq_number} in {repo_identifier}.'
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
- text: Create a revert of pull request {pullreq_number} in repo {repo_identifier} on branch {revert_branch}.
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
revert_branch: requestBody.revert_branch
method: generated
generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/reviewers'].get
update:
x-apievangelist-phrasing:
intent: List a pull request's individual reviewers
effect: read
questions:
- Who is assigned to review this pull request, and have they approved?
- Which individual reviewers still haven't reviewed my PR?
instructions:
- text: 'List the individual reviewers on PR #{pullreq_number} in {repo_identifier}.'
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
- text: Show each person reviewing pull request {pullreq_number} in repo {repo_identifier} and their decision.
slots:
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
method: generated
generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/reviewers'].put
update:
x-apievangelist-phrasing:
intent: Add a reviewer to a pull request
effect: write
questions:
- Can I request a review from a specific teammate on my PR?
- How do I add one more person as a reviewer after the pull request is open?
instructions:
- text: 'Add user {reviewer_id} as a reviewer on PR #{pullreq_number} in {repo_identifier}.'
slots:
reviewer_id: requestBody.reviewer_id
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
- text: Request a review from {reviewer_id} on pull request {pullreq_number} of repo {repo_identifier}.
slots:
reviewer_id: requestBody.reviewer_id
pullreq_number: path.pullreq_number
repo_identifier: path.repo_identifier
method: generated
generated: '2026-09-26'
# --- truncated at 32 KB (47 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/overlays/harness-pullreq-api-phrasing-overlay.yaml