GitHub · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for GitHub v3 REST Issues API
41 actions
41 updates
phrasing
extends
openapi/github-issues-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.
What the actions change
x-apievangelist-phrasing
Targets 41 · first 16 shown; the file carries all of them
$.info
$.paths['/issues'].get
$.paths['/orgs/{org}/issues'].get
$.paths['/repos/{owner}/{repo}/assignees'].get
$.paths['/repos/{owner}/{repo}/assignees/{assignee}'].get
$.paths['/repos/{owner}/{repo}/issues'].get
$.paths['/repos/{owner}/{repo}/issues'].post
$.paths['/repos/{owner}/{repo}/issues/comments'].get
$.paths['/repos/{owner}/{repo}/issues/comments/{comment_id}'].get
$.paths['/repos/{owner}/{repo}/issues/comments/{comment_id}'].delete
$.paths['/repos/{owner}/{repo}/issues/comments/{comment_id}'].patch
$.paths['/repos/{owner}/{repo}/issues/events'].get
$.paths['/repos/{owner}/{repo}/issues/events/{event_id}'].get
$.paths['/repos/{owner}/{repo}/issues/{issue_number}'].get
$.paths['/repos/{owner}/{repo}/issues/{issue_number}'].patch
$.paths['/repos/{owner}/{repo}/issues/{issue_number}/assignees'].post
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 GitHub v3 REST Issues API
version: 1.0.0
extends: openapi/github-issues-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: 40
- target: $.paths['/issues'].get
update:
x-apievangelist-phrasing:
intent: List my issues across every repository I can see
effect: read
questions:
- What issues are assigned to me across all my repos, including organization repositories?
- Can I see every issue I created or was mentioned in, across all the repositories I can access?
instructions:
- text: List every open issue assigned to me across all repositories I can see, including organization repos.
- text: Show issues everywhere I have access to with filter {filter} and state {state}.
slots:
filter: query.filter
state: query.state
- text: List all my visible issues across personal and org repos labeled {labels} updated since {since}.
slots:
labels: query.labels
since: query.since
method: generated
generated: '2026-09-24'
- target: $.paths['/orgs/{org}/issues'].get
update:
x-apievangelist-phrasing:
intent: List my issues in one organization
effect: read
questions:
- Which issues in a single organization are assigned to me?
- Can I narrow my assigned issues down to just one org's repositories?
instructions:
- text: List the issues assigned to me in the {org} organization.
slots:
org: path.org
- text: Show my {state} issues in org {org} with label {labels}.
slots:
org: path.org
state: query.state
labels: query.labels
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/assignees'].get
update:
x-apievangelist-phrasing:
intent: List who can be assigned issues in a repository
effect: read
questions:
- Who are the available assignees for issues in a repository?
- Which people can I hand issues to in this repo?
instructions:
- text: List the available assignees for {owner}/{repo}.
slots:
owner: path.owner
repo: path.repo
- text: Show everyone I could assign issues to in the {repo} repo owned by {owner}.
slots:
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/assignees/{assignee}'].get
update:
x-apievangelist-phrasing:
intent: Check if a user can be assigned issues in a repo
effect: read
questions:
- Does a given user have permission to be assigned issues in this repository at all?
- Can I confirm someone is an eligible assignee for a repo before I assign them anything?
instructions:
- text: Check whether {assignee} can be assigned issues in {owner}/{repo}.
slots:
assignee: path.assignee
owner: path.owner
repo: path.repo
- text: Verify that user {assignee} is an allowed assignee for repository {repo} under {owner}.
slots:
assignee: path.assignee
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/issues'].get
update:
x-apievangelist-phrasing:
intent: List issues in a repository
effect: read
questions:
- How do I list the open issues in one specific repository?
- Can I filter a repo's issues by milestone, assignee, creator or who was mentioned?
- Which issues in a repository carry a particular label?
instructions:
- text: List the open issues in {owner}/{repo}.
slots:
owner: path.owner
repo: path.repo
- text: Show issues in {owner}/{repo} assigned to {assignee} with label {labels}.
slots:
owner: path.owner
repo: path.repo
assignee: query.assignee
labels: query.labels
- text: List issues in {owner}/{repo} opened by {creator} under milestone {milestone}.
slots:
owner: path.owner
repo: path.repo
creator: query.creator
milestone: query.milestone
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/issues'].post
update:
x-apievangelist-phrasing:
intent: Open a new issue in a repository
effect: write
questions:
- How do I file a new issue in a repository through the API?
- Can I set assignees, labels and a milestone at the moment I open an issue?
instructions:
- text: Open an issue in {owner}/{repo} titled {title}.
slots:
owner: path.owner
repo: path.repo
title: requestBody.title
- text: File a new issue in {owner}/{repo} titled {title} with description {body} and labels {labels}.
slots:
owner: path.owner
repo: path.repo
title: requestBody.title
body: requestBody.body
labels: requestBody.labels
- text: Create an issue {title} in {owner}/{repo} and assign it to {assignees}.
slots:
owner: path.owner
repo: path.repo
title: requestBody.title
assignees: requestBody.assignees
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/issues/comments'].get
update:
x-apievangelist-phrasing:
intent: List issue comments across a whole repository
effect: read
questions:
- What comments have been left on issues and pull requests across an entire repository?
- Can I pull every issue comment in a repo posted since a certain date?
instructions:
- text: List all issue and pull request comments in {owner}/{repo}.
slots:
owner: path.owner
repo: path.repo
- text: Show every issue comment across repository {owner}/{repo} since {since}.
slots:
owner: path.owner
repo: path.repo
since: query.since
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/issues/comments/{comment_id}'].get
update:
x-apievangelist-phrasing:
intent: Get one issue comment by its id
effect: read
questions:
- How can I look up a single issue comment when I only have its comment id?
- What did one particular comment on an issue say?
instructions:
- text: Get issue comment {comment_id} in {owner}/{repo}.
slots:
comment_id: path.comment_id
owner: path.owner
repo: path.repo
- text: Show me the text and author of comment {comment_id} from {owner}/{repo}.
slots:
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}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an issue comment
effect: destructive
questions:
- Can I remove a comment someone posted on an issue or pull request?
- How do I delete an issue comment I no longer want visible?
instructions:
- text: Delete issue comment {comment_id} in {owner}/{repo}.
slots:
comment_id: path.comment_id
owner: path.owner
repo: path.repo
- text: Remove the comment {comment_id} from the issue thread in {owner}/{repo}.
slots:
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}'].patch
update:
x-apievangelist-phrasing:
intent: Edit an existing issue comment
effect: write
questions:
- Can I edit the text of an issue comment after it has been posted?
- What's the way to fix a typo in a comment I already left on an issue?
instructions:
- text: Change issue comment {comment_id} in {owner}/{repo} to read {body}.
slots:
comment_id: path.comment_id
owner: path.owner
repo: path.repo
body: requestBody.body
- text: Edit my existing comment {comment_id} on {owner}/{repo} so it says {body}.
slots:
comment_id: path.comment_id
owner: path.owner
repo: path.repo
body: requestBody.body
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/issues/events'].get
update:
x-apievangelist-phrasing:
intent: List issue events across a repository
effect: read
questions:
- What issue activity events (closed, labeled, assigned) have happened across a whole repository?
- Can I audit issue events for every issue in a repo at once?
instructions:
- text: List issue events for all issues in {owner}/{repo}.
slots:
owner: path.owner
repo: path.repo
- text: Show the repository-wide issue event log for {owner}/{repo}, {per_page} per page.
slots:
owner: path.owner
repo: path.repo
per_page: query.per_page
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/issues/events/{event_id}'].get
update:
x-apievangelist-phrasing:
intent: Get a single issue event
effect: read
questions:
- What exactly happened in one issue event when I have its event id?
- Can I fetch the details of a single issue event by id?
instructions:
- text: Get issue event {event_id} in {owner}/{repo}.
slots:
event_id: path.event_id
owner: path.owner
repo: path.repo
- text: Show details of event {event_id} from the issues of {owner}/{repo}.
slots:
event_id: path.event_id
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/issues/{issue_number}'].get
update:
x-apievangelist-phrasing:
intent: Get an issue by its number
effect: read
questions:
- How do I fetch the details of one issue by its number?
- What happens when I request an issue that was transferred to another repository?
instructions:
- text: 'Get issue #{issue_number} in {owner}/{repo}.'
slots:
issue_number: path.issue_number
owner: path.owner
repo: path.repo
- text: Show me the title, state and body of issue {issue_number} from {owner}/{repo}.
slots:
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}'].patch
update:
x-apievangelist-phrasing:
intent: Edit, close or reopen an issue
effect: write
questions:
- Can I close an issue and record why it was closed, like completed or not planned?
- What's the way to rename an issue or change its body after it's filed?
- Is it possible to move an existing issue to a different milestone?
instructions:
- text: 'Close issue #{issue_number} in {owner}/{repo} with reason {state_reason}.'
slots:
issue_number: path.issue_number
owner: path.owner
repo: path.repo
state_reason: requestBody.state_reason
- text: Rename issue {issue_number} in {owner}/{repo} to {title}.
slots:
issue_number: path.issue_number
owner: path.owner
repo: path.repo
title: requestBody.title
- text: 'Set issue #{issue_number} in {owner}/{repo} to state {state} and milestone {milestone}.'
slots:
issue_number: path.issue_number
owner: path.owner
repo: path.repo
state: requestBody.state
milestone: requestBody.milestone
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/issues/{issue_number}/assignees'].post
update:
x-apievangelist-phrasing:
intent: Add assignees to an issue
effect: write
questions:
- How do I add more people to an issue without removing who's already assigned?
- What's the maximum number of assignees I can add to an issue in one call?
instructions:
- text: 'Add {assignees} as assignees on issue #{issue_number} in {owner}/{repo}.'
slots:
assignees: requestBody.assignees
issue_number: path.issue_number
owner: path.owner
repo: path.repo
- text: Also assign {assignees} to issue {issue_number} in {owner}/{repo}, keeping current assignees.
slots:
assignees: requestBody.assignees
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}/assignees'].delete
update:
x-apievangelist-phrasing:
intent: Remove assignees from an issue
effect: destructive
questions:
- Can I unassign specific people from an issue?
- What's the way to take someone off an issue they're no longer working on?
instructions:
- text: 'Remove {assignees} from issue #{issue_number} in {owner}/{repo}.'
slots:
assignees: requestBody.assignees
issue_number: path.issue_number
owner: path.owner
repo: path.repo
- text: Unassign {assignees} from issue {issue_number} on {owner}/{repo}.
slots:
assignees: requestBody.assignees
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}/assignees/{assignee}'].get
update:
x-apievangelist-phrasing:
intent: Check if a user can be assigned to a specific issue
effect: read
questions:
- Is a particular user allowed to be assigned to this one issue?
- Can I verify assignment permission for someone on a specific issue number?
instructions:
- text: 'Check whether {assignee} can be assigned to issue #{issue_number} in {owner}/{repo}.'
slots:
assignee: path.assignee
issue_number: path.issue_number
owner: path.owner
repo: path.repo
- text: Confirm that {assignee} has permission to take issue {issue_number} in {owner}/{repo}.
slots:
assignee: path.assignee
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}/comments'].get
update:
x-apievangelist-phrasing:
intent: List the comments on one issue
effect: read
questions:
- What has been said in the comment thread of a particular issue?
- Can I get only the comments on an issue posted after a certain time?
instructions:
- text: 'List the comments on issue #{issue_number} in {owner}/{repo}.'
slots:
issue_number: path.issue_number
owner: path.owner
repo: path.repo
- text: Show comments on issue {issue_number} of {owner}/{repo} since {since}.
slots:
issue_number: path.issue_number
owner: path.owner
repo: path.repo
since: query.since
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/issues/{issue_number}/comments'].post
update:
x-apievangelist-phrasing:
intent: Comment on an issue or pull request
effect: write
questions:
- How do I post a comment on an issue through the API?
- Can I leave a regular conversation comment on a pull request using the issues endpoints?
instructions:
- text: 'Comment {body} on issue #{issue_number} in {owner}/{repo}.'
slots:
body: requestBody.body
issue_number: path.issue_number
owner: path.owner
repo: path.repo
- text: 'Post a new comment saying {body} on the conversation of #{issue_number} in {owner}/{repo}.'
slots:
body: requestBody.body
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}/events'].get
update:
x-apievangelist-phrasing:
intent: List the events on one issue
effect: read
questions:
- Who labeled, assigned or closed a specific issue, and when?
- Can I see the event history for a single issue?
instructions:
- text: 'List the events on issue #{issue_number} in {owner}/{repo}.'
slots:
issue_number: path.issue_number
owner: path.owner
repo: path.repo
- text: Show who changed issue {issue_number} in {owner}/{repo} and what they did.
slots:
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}/labels'].get
update:
x-apievangelist-phrasing:
intent: List the labels on an issue
effect: read
questions:
- Which labels are currently applied to a given issue?
- What tags does this one issue carry right now?
instructions:
- text: 'List the labels on issue #{issue_number} in {owner}/{repo}.'
slots:
issue_number: path.issue_number
owner: path.owner
repo: path.repo
- text: Show what labels issue {issue_number} in {owner}/{repo} currently has.
slots:
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}/labels'].put
update:
x-apievangelist-phrasing:
intent: Replace all labels on an issue
effect: write
questions:
- Can I overwrite an issue's labels so only a new set remains?
- What's the way to swap out every existing label on an issue in one go?
instructions:
- text: 'Replace all labels on issue #{issue_number} in {owner}/{repo} with a new set.'
slots:
issue_number: path.issue_number
owner: path.owner
repo: path.repo
- text: Clear the previous labels on issue {issue_number} in {owner}/{repo} and set fresh ones.
slots:
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}/labels'].post
update:
x-apievangelist-phrasing:
intent: Add labels to an issue
effect: write
questions:
- How do I tag an issue with extra labels while keeping the ones it has?
- What happens if I send an empty label list when adding labels to an issue?
instructions:
- text: 'Add labels to issue #{issue_number} in {owner}/{repo} without removing existing ones.'
slots:
issue_number: path.issue_number
owner: path.owner
repo: path.repo
- text: Append more labels onto issue {issue_number} in {owner}/{repo}.
slots:
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}/labels'].delete
update:
x-apievangelist-phrasing:
intent: Remove every label from an issue
effect: destructive
questions:
- Can I strip all labels off an issue at once?
- Is there a single call that leaves an issue with no labels at all?
instructions:
- text: 'Remove all labels from issue #{issue_number} in {owner}/{repo}.'
slots:
issue_number: path.issue_number
owner: path.owner
repo: path.repo
- text: Wipe every label off issue {issue_number} on {owner}/{repo}.
slots:
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}/labels/{name}'].delete
update:
x-apievangelist-phrasing:
intent: Remove one label from an issue
effect: destructive
questions:
- How do I take a single named label off an issue and keep the rest?
- What does the API return if the label I try to remove isn't on the issue?
instructions:
- text: 'Remove the {name} label from issue #{issue_number} in {owner}/{repo}.'
slots:
name: path.name
issue_number: path.issue_number
owner: path.owner
repo: path.repo
- text: Take label {name} off issue {issue_number} on {owner}/{repo} and show the labels left.
slots:
name: path.name
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}/lock'].put
update:
x-apievangelist-phrasing:
intent: Lock an issue's conversation
effect: write
questions:
- Can I lock a heated issue or pull request conversation so no one else can comment?
- Which reasons can I give when locking a conversation, like off-topic or resolved?
instructions:
- text: 'Lock the conversation on issue #{issue_number} in {owner}/{repo}.'
slots:
issue_number: path.issue_number
owner: path.owner
repo: path.repo
- text: Lock issue {issue_number} in {owner}/{repo} with reason {lock_reason}.
slots:
issue_number: path.issue_number
owner: path.owner
repo: path.repo
lock_reason: requestBody.lock_reason
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/issues/{issue_number}/lock'].delete
update:
x-apievangelist-phrasing:
intent: Unlock an issue's conversation
effect: destructive
questions:
- How do I reopen a locked issue conversation so people can comment again?
- Can I lift the lock on an issue thread?
instructions:
- text: 'Unlock the conversation on issue #{issue_number} in {owner}/{repo}.'
slots:
issue_number: path.issue_number
owner: path.owner
repo: path.repo
- text: Allow comments again on locked issue {issue_number} in {owner}/{repo}.
slots:
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}/timeline'].get
update:
x-apievangelist-phrasing:
intent: Get the full timeline of an issue
effect: read
questions:
- Can I see an issue's complete timeline, including cross-references and comments, in order?
- What's the full chronological story of everything that happened on an issue?
instructions:
- text: 'Show the timeline of issue #{issue_number} in {owner}/{repo}.'
slots:
issue_number: path.issue_number
owner: path.owner
repo: path.repo
- text: List all timeline events for issue {issue_number} on {owner}/{repo}, {per_page} per page.
slots:
issue_number: path.issue_number
owner: path.owner
repo: path.repo
per_page: query.per_page
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/labels'].get
update:
x-apievangelist-phrasing:
intent: List all labels defined in a repository
effect: read
questions:
- Which labels are defined in a repository that I could apply to issues?
- What label set does this repo use?
instructions:
- text: List all labels in {owner}/{repo}.
slots:
owner: path.owner
repo: path.repo
- text: Show every label available in the {repo} repository owned by {owner}.
slots:
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/labels'].post
update:
x-apievangelist-phrasing:
intent: Create a new label in a repository
effect: write
questions:
- How do I add a new label with a color to a repository?
- Can I give a new repo label a description when I create it?
instructions:
- text: Create a label {name} in {owner}/{repo} with color {color}.
slots:
name: requestBody.name
owner: path.owner
repo: path.repo
color: requestBody.color
- text: Add a new label {name} to {owner}/{repo} described as {description}.
slots:
name: requestBody.name
owner: path.owner
repo: path.repo
description: requestBody.description
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/labels/{name}'].get
update:
x-apievangelist-phrasing:
intent: Get a repository label by name
effect: read
questions:
- What color and description does a specific label in a repo have?
- Does a label with a given name exist in this repository?
instructions:
- text: Get the {name} label from {owner}/{repo}.
slots:
name: path.name
owner: path.owner
repo: path.repo
- text: Show the color and description of label {name} in {owner}/{repo}.
slots:
name: path.name
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/labels/{name}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a label from a repository
effect: destructive
questions:
- Can I delete a label entirely from a repository, not just from one issue?
- What's the way to retire a label a repo no longer uses?
instructions:
- text: Delete the {name} label from repository {owner}/{repo}.
slots:
name: path.name
owner: path.owner
repo: path.repo
- text: Permanently remove label {name} from the label set of {owner}/{repo}.
slots:
name: path.name
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/labels/{name}'].patch
update:
x-apievangelist-phrasing:
intent: Rename or recolor a repository label
effect: write
questions:
- How do I rename an existing label in a repository?
- Can I change a label's color or description without recreating it?
instructions:
- text: Rename label {name} in {owner}/{repo} to {new_name}.
slots:
name: path.name
owner: path.owner
repo: path.repo
new_name: requestBody.new_name
- text: Change the color of existing label {name} in {owner}/{repo} to {color}.
slots:
name: path.name
owner: path.owner
repo: path.repo
color: requestBody.color
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/milestones'].get
update:
x-apievangelist-phrasing:
intent: List milestones in a repository
effect: read
questions:
- Which milestones does a repository have, open or closed?
- Can I sort a repo's milestones by due date or completeness?
instructions:
- text: List the open milestones in {owner}/{repo}.
slots:
owner: path.owner
repo: path.repo
- text: Show {state} milestones in {owner}/{repo} sorted by {sort}.
slots:
owner: path.owner
repo: path.repo
state: query.state
sort: query.sort
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/milestones'].post
update:
x-apievangelist-phrasing:
intent: Create a milestone in a repository
effect: write
questions:
- How do I set up a new milestone with a due date for a release?
- Can I add a description when creating a repo milestone?
instructions:
- text: Create a milestone {title} in {owner}/{repo}.
slots:
title: requestBody.title
owner: path.owner
repo: path.repo
- text: Add milestone {title} to {owner}/{repo} due on {due_on}.
slots:
title: requestBody.title
owner: path.owner
repo: path.repo
due_on: requestBody.due_on
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/milestones/{milestone_number}'].get
update:
x-apievangelist-phrasing:
intent: Get a milestone by its number
effect: read
questions:
- What's the due date and progress of one particular milestone?
- Can I look up a milestone's details by its number?
instructions:
- text: Get milestone {milestone_number} in {owner}/{repo}.
slots:
milestone_number: path.milestone_number
owner: path.owner
repo: path.repo
- text: Show the due date and open issue count for milestone {milestone_number} of {owner}/{repo}.
slots:
milestone_number: path.milestone_number
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/milestones/{milestone_number}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a milestone
effect: destructive
questions:
- Can I delete a milestone that's no longer needed?
- What's the way to get rid of an obsolete milestone in a repo?
instructions:
- text: Delete milestone {milestone_number} from {owner}/{repo}.
slots:
milestone_number: path.milestone_number
owner: path.owner
repo: path.repo
- text: Permanently remove milestone number {milestone_number} in {owner}/{repo}.
slots:
milestone_number: path.milestone_number
owner: path.owner
repo: path.repo
method: generated
generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/milestones/{milestone_number}'].patch
update:
x-apievangelist-phrasing:
intent: Update, close or reschedule a milestone
effect: write
questions:
- How can I push back a milestone's due date?
- Can I close a milestone or rename it after it's created?
instructions:
- text: Move the due date of milestone {milestone_number} in {owner}/{repo} to {due_on}.
slots:
milestone_number: path.milestone_number
owner: path.owner
repo: path.repo
due_on: requestBody.due_on
- text: Set milestone {milestone_number} in {owner}/{repo} to state {state}.
slots:
milestone_number: path.milestone_number
owner: path.owner
repo: path.repo
state: requestBody.state
- text: Rename existing milestone {milestone_number} in {owner}/{repo} to {title}.
slots:
milestone_number: path.milestone_number
owner: path.owner
repo: path.repo
title: requestBody.title
method: generated
generated: '2026-09-24'
# --- truncated at 32 KB (33 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/overlays/github-issues-api-phrasing-overlay.yaml