GitHub · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GitHub v3 REST Reactions API

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

What the actions change

x-apievangelist-phrasing

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

$.info
$.paths['/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions'].get
$.paths['/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions'].post
$.paths['/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}'].delete
$.paths['/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions'].get
$.paths['/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions'].post
$.paths['/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}'].delete
$.paths['/repos/{owner}/{repo}/comments/{comment_id}/reactions'].get
$.paths['/repos/{owner}/{repo}/comments/{comment_id}/reactions'].post
$.paths['/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}'].delete
$.paths['/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions'].get
$.paths['/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions'].post
$.paths['/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}'].delete
$.paths['/repos/{owner}/{repo}/issues/{issue_number}/reactions'].get
$.paths['/repos/{owner}/{repo}/issues/{issue_number}/reactions'].post
$.paths['/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}'].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 GitHub v3 REST Reactions API
  version: 1.0.0
extends: openapi/github-reactions-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 25
- target: $.paths['/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List reactions on a team discussion comment
      effect: read
      questions:
      - What emoji reactions has a reply on our team discussion received?
      - Can I count only the thumbs-up reactions on a team discussion reply?
      instructions:
      - text: List reactions to reply {comment_number} under discussion {discussion_number} of team {team_slug} in {org}.
        slots:
          comment_number: path.comment_number
          discussion_number: path.discussion_number
          team_slug: path.team_slug
          org: path.org
      - text: Show only {content} reactions on comment {comment_number}, team {team_slug} thread {discussion_number}, {org}.
        slots:
          content: query.content
          comment_number: path.comment_number
          team_slug: path.team_slug
          discussion_number: path.discussion_number
          org: path.org
      method: generated
      generated: '2026-09-24'
- target: $.paths['/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions'].post
  update:
    x-apievangelist-phrasing:
      intent: React to a team discussion comment
      effect: write
      questions:
      - How do I add an emoji reaction to a reply in a team discussion?
      - What does a 200 response mean when reacting to a team discussion comment?
      instructions:
      - text: React with {content} to reply {comment_number} on discussion {discussion_number} of team {team_slug} in {org}.
        slots:
          content: requestBody.content
          comment_number: path.comment_number
          discussion_number: path.discussion_number
          team_slug: path.team_slug
          org: path.org
      - text: Add a {content} emoji to comment {comment_number} in {team_slug}'s thread {discussion_number} ({org}).
        slots:
          content: requestBody.content
          comment_number: path.comment_number
          team_slug: path.team_slug
          discussion_number: path.discussion_number
          org: path.org
      method: generated
      generated: '2026-09-24'
- target: $.paths['/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a reaction from a team discussion comment
      effect: destructive
      questions:
      - Can I take back an emoji reaction I left on a team discussion reply?
      - Which ID do I need to remove a reaction from a team discussion comment?
      instructions:
      - text: Delete reaction {reaction_id} from reply {comment_number} on discussion {discussion_number} of team {team_slug} in {org}.
        slots:
          reaction_id: path.reaction_id
          comment_number: path.comment_number
          discussion_number: path.discussion_number
          team_slug: path.team_slug
          org: path.org
      - text: Undo my emoji {reaction_id} on comment {comment_number}, {team_slug} thread {discussion_number}, {org}.
        slots:
          reaction_id: path.reaction_id
          comment_number: path.comment_number
          team_slug: path.team_slug
          discussion_number: path.discussion_number
          org: path.org
      method: generated
      generated: '2026-09-24'
- target: $.paths['/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List reactions on a team discussion
      effect: read
      questions:
      - How are people reacting to a discussion post on our team page?
      - Can I filter a team discussion's reactions to just hearts?
      instructions:
      - text: List reactions to the top post of discussion {discussion_number} on team {team_slug} in {org}.
        slots:
          discussion_number: path.discussion_number
          team_slug: path.team_slug
          org: path.org
      - text: Show {content} reactions on {team_slug}'s discussion post {discussion_number} in {org}.
        slots:
          content: query.content
          team_slug: path.team_slug
          discussion_number: path.discussion_number
          org: path.org
      method: generated
      generated: '2026-09-24'
- target: $.paths['/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions'].post
  update:
    x-apievangelist-phrasing:
      intent: React to a team discussion
      effect: write
      questions:
      - Can I put an emoji reaction on a team discussion post itself?
      - What happens if I add the same reaction to a team discussion twice?
      instructions:
      - text: React with {content} to discussion post {discussion_number} on team {team_slug} in {org}.
        slots:
          content: requestBody.content
          discussion_number: path.discussion_number
          team_slug: path.team_slug
          org: path.org
      - text: Add a {content} emoji to the {team_slug} team's discussion {discussion_number} in {org}.
        slots:
          content: requestBody.content
          team_slug: path.team_slug
          discussion_number: path.discussion_number
          org: path.org
      method: generated
      generated: '2026-09-24'
- target: $.paths['/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a reaction from a team discussion
      effect: destructive
      questions:
      - How can I remove a reaction I put on a team discussion post?
      - Can I delete an emoji reaction from a team page discussion?
      instructions:
      - text: Delete reaction {reaction_id} from discussion post {discussion_number} on team {team_slug} in {org}.
        slots:
          reaction_id: path.reaction_id
          discussion_number: path.discussion_number
          team_slug: path.team_slug
          org: path.org
      - text: Undo emoji {reaction_id} on the {team_slug} team's discussion {discussion_number} in {org}.
        slots:
          reaction_id: path.reaction_id
          team_slug: path.team_slug
          discussion_number: path.discussion_number
          org: path.org
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/comments/{comment_id}/reactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List reactions on a commit comment
      effect: read
      questions:
      - What reactions has a comment on a commit gotten?
      - Can I see just the rocket reactions on a commit comment?
      instructions:
      - text: List reactions to commit comment {comment_id} in {owner}/{repo}.
        slots:
          comment_id: path.comment_id
          owner: path.owner
          repo: path.repo
      - text: Show {content} reactions on commit comment {comment_id} in {owner}/{repo}.
        slots:
          content: query.content
          comment_id: path.comment_id
          owner: path.owner
          repo: path.repo
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/comments/{comment_id}/reactions'].post
  update:
    x-apievangelist-phrasing:
      intent: React to a commit comment
      effect: write
      questions:
      - How do I add an emoji reaction to a comment on a commit?
      - Is reacting to a commit comment idempotent if I already reacted?
      instructions:
      - text: React with {content} to commit comment {comment_id} in {owner}/{repo}.
        slots:
          content: requestBody.content
          comment_id: path.comment_id
          owner: path.owner
          repo: path.repo
      - text: Add a {content} emoji to the commit comment {comment_id} on repo {owner}/{repo}.
        slots:
          content: requestBody.content
          comment_id: path.comment_id
          owner: path.owner
          repo: path.repo
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a reaction from a commit comment
      effect: destructive
      questions:
      - Can I remove a reaction I added to a commit comment?
      - What IDs are needed to delete a reaction on a commit comment?
      instructions:
      - text: Delete reaction {reaction_id} from commit comment {comment_id} in {owner}/{repo}.
        slots:
          reaction_id: path.reaction_id
          comment_id: path.comment_id
          owner: path.owner
          repo: path.repo
      - text: Undo emoji {reaction_id} on the commit comment {comment_id}, repo {owner}/{repo}.
        slots:
          reaction_id: path.reaction_id
          comment_id: path.comment_id
          owner: path.owner
          repo: path.repo
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List reactions on an issue comment
      effect: read
      questions:
      - How many people reacted to a specific comment on an issue?
      - Can I list only the confused reactions on an issue comment?
      instructions:
      - text: List reactions to issue comment {comment_id} in {owner}/{repo}.
        slots:
          comment_id: path.comment_id
          owner: path.owner
          repo: path.repo
      - text: Show {content} reactions left on issue comment {comment_id} of {owner}/{repo}.
        slots:
          content: query.content
          comment_id: path.comment_id
          owner: path.owner
          repo: path.repo
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions'].post
  update:
    x-apievangelist-phrasing:
      intent: React to an issue comment
      effect: write
      questions:
      - How do I thumbs-up someone's comment on an issue?
      - Which reaction types can I add to an issue comment?
      instructions:
      - text: React with {content} to issue comment {comment_id} in {owner}/{repo}.
        slots:
          content: requestBody.content
          comment_id: path.comment_id
          owner: path.owner
          repo: path.repo
      - text: Add a {content} emoji to the issue comment {comment_id} on repo {owner}/{repo}.
        slots:
          content: requestBody.content
          comment_id: path.comment_id
          owner: path.owner
          repo: path.repo
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a reaction from an issue comment
      effect: destructive
      questions:
      - Can I retract my emoji on someone's issue comment?
      - How do I delete a reaction from a comment on an issue?
      instructions:
      - text: Delete reaction {reaction_id} from issue comment {comment_id} in {owner}/{repo}.
        slots:
          reaction_id: path.reaction_id
          comment_id: path.comment_id
          owner: path.owner
          repo: path.repo
      - text: Undo emoji {reaction_id} on the issue comment {comment_id}, repo {owner}/{repo}.
        slots:
          reaction_id: path.reaction_id
          comment_id: path.comment_id
          owner: path.owner
          repo: path.repo
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/issues/{issue_number}/reactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List reactions on an issue
      effect: read
      questions:
      - How many thumbs-up votes does an issue have?
      - Can I see every reaction on the issue itself, not its comments?
      instructions:
      - text: 'List reactions to issue #{issue_number} in {owner}/{repo}.'
        slots:
          issue_number: path.issue_number
          owner: path.owner
          repo: path.repo
      - text: Count the {content} reactions on issue {issue_number} of {owner}/{repo}.
        slots:
          content: query.content
          issue_number: path.issue_number
          owner: path.owner
          repo: path.repo
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/issues/{issue_number}/reactions'].post
  update:
    x-apievangelist-phrasing:
      intent: React to an issue
      effect: write
      questions:
      - Can I upvote an issue with a reaction through the API?
      - What if I add a reaction to an issue that I already reacted to?
      instructions:
      - text: 'React with {content} to issue #{issue_number} in {owner}/{repo}.'
        slots:
          content: requestBody.content
          issue_number: path.issue_number
          owner: path.owner
          repo: path.repo
      - text: Put a {content} emoji on the issue {issue_number} itself in {owner}/{repo}.
        slots:
          content: requestBody.content
          issue_number: path.issue_number
          owner: path.owner
          repo: path.repo
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a reaction from an issue
      effect: destructive
      questions:
      - How do I remove my vote reaction from an issue?
      - Can I delete a reaction on the issue body rather than a comment?
      instructions:
      - text: 'Delete reaction {reaction_id} from issue #{issue_number} in {owner}/{repo}.'
        slots:
          reaction_id: path.reaction_id
          issue_number: path.issue_number
          owner: path.owner
          repo: path.repo
      - text: Take my emoji {reaction_id} off the issue {issue_number} itself in {owner}/{repo}.
        slots:
          reaction_id: path.reaction_id
          issue_number: path.issue_number
          owner: path.owner
          repo: path.repo
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List reactions on a pull request review comment
      effect: read
      questions:
      - What reactions has an inline review comment on a pull request received?
      - Can I filter reactions on a PR review comment by type?
      instructions:
      - text: List reactions to pull request review comment {comment_id} in {owner}/{repo}.
        slots:
          comment_id: path.comment_id
          owner: path.owner
          repo: path.repo
      - text: Show {content} reactions on the inline PR review comment {comment_id}, {owner}/{repo}.
        slots:
          content: query.content
          comment_id: path.comment_id
          owner: path.owner
          repo: path.repo
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions'].post
  update:
    x-apievangelist-phrasing:
      intent: React to a pull request review comment
      effect: write
      questions:
      - How can I react to an inline code review comment on a pull request?
      - Can I add an eyes reaction to a PR review comment to show I'm looking at it?
      instructions:
      - text: React with {content} to pull request review comment {comment_id} in {owner}/{repo}.
        slots:
          content: requestBody.content
          comment_id: path.comment_id
          owner: path.owner
          repo: path.repo
      - text: Add a {content} emoji to the inline PR review comment {comment_id} on {owner}/{repo}.
        slots:
          content: requestBody.content
          comment_id: path.comment_id
          owner: path.owner
          repo: path.repo
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a reaction from a pull request comment
      effect: destructive
      questions:
      - Can I remove my reaction from an inline pull request review comment?
      - Which IDs identify a reaction on a PR review comment for deletion?
      instructions:
      - text: Delete reaction {reaction_id} from pull request review comment {comment_id} in {owner}/{repo}.
        slots:
          reaction_id: path.reaction_id
          comment_id: path.comment_id
          owner: path.owner
          repo: path.repo
      - text: Undo emoji {reaction_id} on the inline PR review comment {comment_id}, {owner}/{repo}.
        slots:
          reaction_id: path.reaction_id
          comment_id: path.comment_id
          owner: path.owner
          repo: path.repo
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/releases/{release_id}/reactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List reactions on a release
      effect: read
      questions:
      - How are people reacting to our latest release?
      - Can I count the hooray reactions on a release?
      instructions:
      - text: List reactions to release {release_id} in {owner}/{repo}.
        slots:
          release_id: path.release_id
          owner: path.owner
          repo: path.repo
      - text: Show {content} reactions on the {owner}/{repo} release {release_id}.
        slots:
          content: query.content
          owner: path.owner
          repo: path.repo
          release_id: path.release_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/releases/{release_id}/reactions'].post
  update:
    x-apievangelist-phrasing:
      intent: React to a release
      effect: write
      questions:
      - Can I celebrate a release with an emoji reaction?
      - Which reaction types are allowed on a release?
      instructions:
      - text: React with {content} to release {release_id} in {owner}/{repo}.
        slots:
          content: requestBody.content
          release_id: path.release_id
          owner: path.owner
          repo: path.repo
      - text: Add a {content} emoji to the {owner}/{repo} release {release_id}.
        slots:
          content: requestBody.content
          owner: path.owner
          repo: path.repo
          release_id: path.release_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a reaction from a release
      effect: destructive
      questions:
      - How do I remove a reaction I left on a release?
      - Can a reaction on a release be deleted?
      instructions:
      - text: Delete reaction {reaction_id} from release {release_id} in {owner}/{repo}.
        slots:
          reaction_id: path.reaction_id
          release_id: path.release_id
          owner: path.owner
          repo: path.repo
      - text: Undo my emoji {reaction_id} on the {owner}/{repo} release {release_id}.
        slots:
          reaction_id: path.reaction_id
          owner: path.owner
          repo: path.repo
          release_id: path.release_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List team discussion comment reactions (legacy)
      effect: read
      questions:
      - Can I list reactions on a team discussion reply using just the numeric team ID?
      - Is the old team-ID route for comment reactions deprecated?
      instructions:
      - text: Using the legacy team ID route, list reactions to reply {comment_number} under discussion {discussion_number} of team {team_id}.
        slots:
          comment_number: path.comment_number
          discussion_number: path.discussion_number
          team_id: path.team_id
      - text: Via the deprecated endpoint, show {content} reactions on comment {comment_number}, thread {discussion_number}, numeric team {team_id}.
        slots:
          content: query.content
          comment_number: path.comment_number
          discussion_number: path.discussion_number
          team_id: path.team_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions'].post
  update:
    x-apievangelist-phrasing:
      intent: React to a team discussion comment (legacy)
      effect: write
      questions:
      - Can I react to a team discussion reply through the numeric team ID route?
      - Is adding comment reactions by team ID still supported?
      instructions:
      - text: Using the legacy team ID route, react with {content} to reply {comment_number} under discussion {discussion_number} of team {team_id}.
        slots:
          content: requestBody.content
          comment_number: path.comment_number
          discussion_number: path.discussion_number
          team_id: path.team_id
      - text: Via the deprecated endpoint, add emoji {content} to comment {comment_number}, thread {discussion_number}, numeric team {team_id}.
        slots:
          content: requestBody.content
          comment_number: path.comment_number
          discussion_number: path.discussion_number
          team_id: path.team_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/teams/{team_id}/discussions/{discussion_number}/reactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List team discussion reactions (legacy)
      effect: read
      questions:
      - Can I see reactions on a team discussion post with only the numeric team ID?
      - Is listing discussion reactions by team ID being retired?
      instructions:
      - text: Using the legacy team ID route, list reactions to the top post of discussion {discussion_number} on team {team_id}.
        slots:
          discussion_number: path.discussion_number
          team_id: path.team_id
      - text: Via the deprecated endpoint, show {content} reactions on discussion post {discussion_number} of numeric team {team_id}.
        slots:
          content: query.content
          discussion_number: path.discussion_number
          team_id: path.team_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/teams/{team_id}/discussions/{discussion_number}/reactions'].post
  update:
    x-apievangelist-phrasing:
      intent: React to a team discussion (legacy)
      effect: write
      questions:
      - Can I react to a team discussion post via the numeric team ID route?
      - Is the ID-based route for reacting to team discussions deprecated?
      instructions:
      - text: Using the legacy team ID route, react with {content} to discussion post {discussion_number} on team {team_id}.
        slots:
          content: requestBody.content
          discussion_number: path.discussion_number
          team_id: path.team_id
      - text: Via the deprecated endpoint, add emoji {content} to the top post of thread {discussion_number}, numeric team {team_id}.
        slots:
          content: requestBody.content
          discussion_number: path.discussion_number
          team_id: path.team_id
      method: generated
      generated: '2026-09-24'