jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 18:10:59 -05:00
Code Issues Projects Releases Wiki Activity

update titles for REST API copilot, interactions, issues docs (#49514)

Browse Source
This commit is contained in:
Sarah Edwards
2024-03-05 09:19:05 -08:00
committed by GitHub
parent 6ae01c3892
commit 1ab862e373
17 changed files with 30 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
content/actions/using-workflows/events-that-trigger-workflows.md
View File

@@ -345,7 +345,7 @@ jobs:
{% data reusables.actions.branch-requirement %} {% data reusables.actions.branch-requirement %}
Runs your workflow when an issue in the workflow's repository is created or modified. For activity related to comments in an issue, use the [`issue_comment`](#issue_comment) event. For more information about issues, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/about-issues)." For information about the issue APIs, see "[AUTOTITLE](/graphql/reference/objects#issue)" in the GraphQL API documentation or "[AUTOTITLE](/rest/issues)" in the REST API documentation. Runs your workflow when an issue in the workflow's repository is created or modified. For activity related to comments in an issue, use the [`issue_comment`](#issue_comment) event. For more information about issues, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/about-issues)." For information about the issue APIs, see "[AUTOTITLE](/graphql/reference/objects#issue)" in the GraphQL API documentation or "[AUTOTITLE](/rest/issues)."
For example, you can run a workflow when an issue has been `opened`, `edited`, or `milestoned`. For example, you can run a workflow when an issue has been `opened`, `edited`, or `milestoned`.
@@ -369,7 +369,7 @@ on:
{% data reusables.actions.branch-requirement %} {% data reusables.actions.branch-requirement %}
Runs your workflow when a label in your workflow's repository is created or modified. For more information about labels, see "[AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the label APIs, see "[AUTOTITLE](/graphql/reference/objects#label)" in the GraphQL API documentation or "[AUTOTITLE](/rest/issues#labels)" in the REST API documentation. Runs your workflow when a label in your workflow's repository is created or modified. For more information about labels, see "[AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the label APIs, see "[AUTOTITLE](/graphql/reference/objects#label)" in the GraphQL API documentation or "[AUTOTITLE](/rest/issues#labels)."
If you want to run your workflow when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` activity types for the [`issues`](#issues), [`pull_request`](#pull_request), [`pull_request_target`](#pull_request_target), or [`discussion`](#discussion) events instead. If you want to run your workflow when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` activity types for the [`issues`](#issues), [`pull_request`](#pull_request), [`pull_request_target`](#pull_request_target), or [`discussion`](#discussion) events instead.
@@ -421,7 +421,7 @@ on:
{% data reusables.actions.branch-requirement %} {% data reusables.actions.branch-requirement %}
Runs your workflow when a milestone in the workflow's repository is created or modified. For more information about milestones, see "[AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the milestone APIs, see "[AUTOTITLE](/graphql/reference/objects#milestone)" in the GraphQL API documentation or "[AUTOTITLE](/rest/issues#milestones)" in the REST API documentation. Runs your workflow when a milestone in the workflow's repository is created or modified. For more information about milestones, see "[AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the milestone APIs, see "[AUTOTITLE](/graphql/reference/objects#milestone)" in the GraphQL API documentation or "[AUTOTITLE](/rest/issues#milestones)."
If you want to run your workflow when an issue is added to or removed from a milestone, use the `milestoned` or `demilestoned` activity types for the [`issues`](#issues) event instead. If you want to run your workflow when an issue is added to or removed from a milestone, use the `milestoned` or `demilestoned` activity types for the [`issues`](#issues) event instead.

2
content/rest/copilot/copilot-user-management.md
View File

@@ -1,5 +1,5 @@
--- ---
title: Copilot user management title: REST API endpoints for Copilot user management
shortTitle: Copilot user management shortTitle: Copilot user management
intro: 'Use the REST API to manage the {% data variables.product.prodname_copilot_for_business %} or {% data variables.product.prodname_copilot_enterprise %} subscription for your organization.' intro: 'Use the REST API to manage the {% data variables.product.prodname_copilot_for_business %} or {% data variables.product.prodname_copilot_enterprise %} subscription for your organization.'
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖

4
content/rest/copilot/index.md
View File

@@ -1,5 +1,6 @@
--- ---
title: Copilot title: REST API endpoints for Copilot
shortTitle: Copilot
intro: >- intro: >-
Use the REST API to manage the {% data Use the REST API to manage the {% data
variables.product.prodname_copilot_for_business %} subscription for your variables.product.prodname_copilot_for_business %} subscription for your
@@ -14,4 +15,3 @@ versions:
fpt: '*' fpt: '*'
ghec: '*' ghec: '*'
--- ---

4
content/rest/interactions/index.md
View File

@@ -1,5 +1,7 @@
--- ---
title: Interactions title: REST API endpoints for interactions
shortTitle: Interactions
allowTitleToDifferFromFilename: true
intro: Use the REST API to set the interaction limit for the users in your organizations and repositories. intro: Use the REST API to set the interaction limit for the users in your organizations and repositories.
permissions: People with owner or admin access can set the interaction limit for the users in their organizations and repositories. permissions: People with owner or admin access can set the interaction limit for the users in their organizations and repositories.
redirect_from: redirect_from:

2
content/rest/interactions/orgs.md
View File

@@ -1,5 +1,5 @@
--- ---
title: Organization interactions title: REST API endpoints for organization interactions
shortTitle: Organization shortTitle: Organization
intro: >- intro: >-
Use the REST API to temporarily restrict which type of user can comment, open Use the REST API to temporarily restrict which type of user can comment, open

2
content/rest/interactions/repos.md
View File

@@ -1,5 +1,5 @@
--- ---
title: Repository interactions title: REST API endpoints for repository interactions
shortTitle: Repository shortTitle: Repository
intro: >- intro: >-
Use the REST API to temporarily restrict which type of user can comment, open Use the REST API to temporarily restrict which type of user can comment, open

2
content/rest/interactions/user.md
View File

@@ -1,5 +1,5 @@
--- ---
title: User interactions title: REST API endpoints for user interactions
shortTitle: User shortTitle: User
allowTitleToDifferFromFilename: true allowTitleToDifferFromFilename: true
intro: >- intro: >-

2
content/rest/issues/assignees.md
View File

@@ -1,5 +1,5 @@
--- ---
title: Issue assignees title: REST API endpoints for issue assignees
allowTitleToDifferFromFilename: true allowTitleToDifferFromFilename: true
shortTitle: Assignees shortTitle: Assignees
intro: Use the REST API to manage assignees on issues and pull requests. intro: Use the REST API to manage assignees on issues and pull requests.

2
content/rest/issues/comments.md
View File

@@ -1,5 +1,5 @@
--- ---
title: Issue comments title: REST API endpoints for issue comments
allowTitleToDifferFromFilename: true allowTitleToDifferFromFilename: true
shortTitle: Comments shortTitle: Comments
intro: Use the REST API to manage comments on issues and pull requests. intro: Use the REST API to manage comments on issues and pull requests.

2
content/rest/issues/events.md
View File

@@ -1,5 +1,5 @@
--- ---
title: Issue events title: REST API endpoints for issue events
allowTitleToDifferFromFilename: true allowTitleToDifferFromFilename: true
shortTitle: Events shortTitle: Events
intro: >- intro: >-

4
content/rest/issues/index.md
View File

@@ -1,5 +1,7 @@
--- ---
title: Issues title: REST API endpoints for issues
shortTitle: Issues
allowTitleToDifferFromFilename: true
intro: 'Use the REST API to view and manage issues, including issue assignees, comments, labels, and milestones.' intro: 'Use the REST API to view and manage issues, including issue assignees, comments, labels, and milestones.'
redirect_from: redirect_from:
- /v3/issues - /v3/issues

4
content/rest/issues/issues.md
View File

@@ -1,5 +1,7 @@
--- ---
title: Issues title: REST API endpoints for issues
shortTitle: Issues
allowTitleToDifferFromFilename: true
intro: Use the REST API to manage issues and pull requests. intro: Use the REST API to manage issues and pull requests.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*' fpt: '*'

4
content/rest/issues/labels.md
View File

@@ -1,5 +1,7 @@
--- ---
title: Labels title: REST API endpoints for labels
shortTitle: Labels
allowTitleToDifferFromFilename: true
intro: 'Use the REST API to manage labels for repositories, issues and pull requests.' intro: 'Use the REST API to manage labels for repositories, issues and pull requests.'
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*' fpt: '*'

4
content/rest/issues/milestones.md
View File

@@ -1,5 +1,7 @@
--- ---
title: Milestones title: REST API endpoints for milestones
shortTitle: Milestones
allowTitleToDifferFromFilename: true
intro: Use the REST API to manage milestones. intro: Use the REST API to manage milestones.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*' fpt: '*'

2
content/rest/issues/timeline.md
View File

@@ -1,5 +1,5 @@
--- ---
title: Timeline events title: REST API endpoints for timeline events
allowTitleToDifferFromFilename: true allowTitleToDifferFromFilename: true
shortTitle: Timeline shortTitle: Timeline
intro: >- intro: >-

2
data/reusables/webhooks/issue_comment_short_desc.md
View File

@@ -1 +1 @@
Activity related to an issue or pull request comment. {% data reusables.webhooks.action_type_desc %} For more information, see the "[AUTOTITLE](/rest/issues#comments)" REST API. Activity related to an issue or pull request comment. {% data reusables.webhooks.action_type_desc %} For more information, see the "[AUTOTITLE](/rest/issues#comments)."

2
data/reusables/webhooks/issues_short_desc.md
View File

@@ -1 +1 @@
Activity related to an issue. {% data reusables.webhooks.action_type_desc %} For more information, see the "[AUTOTITLE](/rest/issues)" REST API. Activity related to an issue. {% data reusables.webhooks.action_type_desc %} For more information, see the "[AUTOTITLE](/rest/issues)."