jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-01-29 21:01:19 -05:00
Code Issues Projects Releases Wiki Activity

Merge pull request #6781 from github/repo-sync

Browse Source 
repo sync
This commit is contained in:
Octomerger Bot
2021-05-26 15:22:25 +10:00
committed by GitHub
parent ad1cdfc6eb 86eb89f697
commit b29be2a2bc
17 changed files with 133 additions and 18354 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
assets/images/help/classroom/assignments-click-new-assignment-button.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 126 KiB

BIN
assets/images/help/classroom/assignments-click-new-starter-assignment-button.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 104 KiB

BIN
assets/images/help/classroom/assignments-create-first-assignment.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 53 KiB

BIN
assets/images/help/classroom/assignments-import-starter-assignment.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 193 KiB

1
content/education/guides.md
View File

@@ -21,6 +21,7 @@ Administer a classroom, assign and review work from your students, and teach the
- [Basics of setting up {% data variables.product.prodname_classroom %} ](/education/manage-coursework-with-github-classroom/basics-of-setting-up-github-classroom)
- [Manage classrooms](/education/manage-coursework-with-github-classroom/manage-classrooms)
- [Use the Git and {% data variables.product.company_short %} starter assignment](/education/manage-coursework-with-github-classroom/use-the-git-and-github-starter-assignment)
- [Create an individual assignment](/education/manage-coursework-with-github-classroom/create-an-individual-assignment)
- [Create a group assignment](/education/manage-coursework-with-github-classroom/create-a-group-assignment)
- [Create an assignment from a template repository](/education/manage-coursework-with-github-classroom/create-an-assignment-from-a-template-repository)

1
content/education/manage-coursework-with-github-classroom/index.md
View File

@@ -10,4 +10,3 @@ children:
- /integrate-github-classroom-with-an-ide
- /learn-with-github-classroom
---

2
content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/index.md
View File

@@ -8,6 +8,7 @@ redirect_from:
- /education/manage-coursework-with-github-classroom/probot-settings
children:
- /manage-classrooms
- /use-the-git-and-github-starter-assignment
- /create-an-individual-assignment
- /create-a-group-assignment
- /create-an-assignment-from-a-template-repository
@@ -15,4 +16,3 @@ children:
- /use-autograding
- /connect-a-learning-management-system-to-github-classroom
---

11
content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms.md
View File

@@ -1,6 +1,6 @@
---
title: Manage classrooms
intro: 'You can create and manage a classroom for each course that you teach using {% data variables.product.prodname_classroom %}.'
intro: You can create and manage a classroom for each course that you teach using {% data variables.product.prodname_classroom %}.
permissions: Organization owners can manage a classroom for an organization.
versions:
free-pro-team: '*'
@@ -8,6 +8,7 @@ redirect_from:
- /education/manage-coursework-with-github-classroom/archive-a-classroom
- /education/manage-coursework-with-github-classroom/manage-classrooms
---
### About classrooms
{% data reusables.classroom.about-classrooms %}
@@ -45,7 +46,7 @@ You must authorize the OAuth app for {% data variables.product.prodname_classroo
!["New classroom" button](/assets/images/help/classroom/click-new-classroom-button.png)
{% data reusables.classroom.guide-create-new-classroom %}
After you create a classroom, you can begin creating assignments for students. For more information, see "[Create an individual assignment](/education/manage-coursework-with-github-classroom/create-an-individual-assignment)" or "[Create a group assignment](/education/manage-coursework-with-github-classroom/create-a-group-assignment)."
After you create a classroom, you can begin creating assignments for students. For more information, see "[Use the Git and {% data variables.product.company_short %} starter assignment](/education/manage-coursework-with-github-classroom/use-the-git-and-github-starter-assignment)," "[Create an individual assignment](/education/manage-coursework-with-github-classroom/create-an-individual-assignment)," or "[Create a group assignment](/education/manage-coursework-with-github-classroom/create-a-group-assignment)."
### Creating a roster for your classroom
@@ -58,10 +59,8 @@ If your course already has a roster, you can update the students on the roster o
{% data reusables.classroom.click-students %}
1. To connect {% data variables.product.prodname_classroom %} to your LMS and import a roster, click {% octicon "mortar-board" aria-label="The mortar board icon" %} **Import from a learning management system** and follow the instructions. For more information, see "[Connect a learning management system to {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom/connect-a-learning-management-system-to-github-classroom)."
!["Import from a learning management system" button](/assets/images/help/classroom/click-import-from-a-learning-management-system-button.png)
1. Provide the student identifiers for your roster.
- To import a roster by uploading a file containing student identifiers, click **Upload a CSV or text file**.
- To create a roster manually, type your student identifiers.
![Text field for typing student identifiers and "Upload a CSV or text file" button](/assets/images/help/classroom/type-or-upload-student-identifiers.png)
1. To create a roster manually, type your student identifiers. Optionally, click **Upload a CSV or text file** to upload a file containing the identifiers.
![Text field for typing student identifiers and "Upload a CSV or text file" button](/assets/images/help/classroom/type-or-upload-student-identifiers.png)
1. Click **Create roster**.
!["Create roster" button](/assets/images/help/classroom/click-create-roster-button.png)

101
content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-the-git-and-github-starter-assignment.md Normal file
View File

@@ -0,0 +1,101 @@
---
title: Use the Git and GitHub starter assignment
intro: You can use the Git & {% data variables.product.company_short %} starter assignment to give students an overview of Git and {% data variables.product.company_short %} fundamentals.
versions:
free-pro-team: '*'
redirect_from:
- /education/manage-coursework-with-github-classroom/use-the-git-and-github-starter-assignment
---
{% note %}
**Note:** The Git & {% data variables.product.company_short %} starter assignment is in beta and subject to change.
{% endnote %}
The Git & {% data variables.product.company_short %} starter assignment is a pre-made course that summarizes the basics of Git and {% data variables.product.company_short %} and links students to resources to learn more about specific topics.
### Prerequisites
{% data reusables.classroom.assignments-classroom-prerequisite %}
### Creating the starter assignment
#### If there are no existing assignments in the classroom
1. Sign into {% data variables.product.prodname_classroom_with_url %}.
2. Navigate to a classroom.
3. In the {% octicon "repo" aria-label="The repo icon" %} **Assignments** tab, click **Use starter assignment**.
<div class="procedural-image-wrapper">
<img alt="Creating your first assignment" class="procedural-image-wrapper" src="/assets/images/help/classroom/assignments-create-first-assignment.png">
</div>
#### If there already are existing assignments in the classroom
1. Sign into {% data variables.product.prodname_classroom_with_url %}.
2. Navigate to a classroom.
3. In the {% octicon "repo" aria-label="The repo icon" %} **Assignments** tab, click the link on the blue banner.
<div class="procedural-image-wrapper">
<img alt="The 'New assignment' button" class="procedural-image-wrapper" src="/assets/images/help/classroom/assignments-click-new-starter-assignment-button.png">
</div>
### Setting up the basics for an assignment
Import the starter course into your organization, name your assignment, decide whether to assign a deadline, and choose the visibility of assignment repositories.
- [Importing the assignment](#importing-the-assignment)
- [Naming an assignment](#naming-an-assignment)
- [Assigning a deadline for an assignment](#assigning-a-deadline-for-an-assignment)
- [Choosing an assignment type](#choosing-an-assignment-type)
- [Choosing a visibility for assignment repositories](#choosing-a-visibility-for-assignment-repositories)
#### Importing the assignment
You first need to import the Git & {% data variables.product.product_name %} starter assignment into your organization.
<div class="procedural-image-wrapper">
<img alt="The `Import the assignment` button" class="procedural-image-wrapper" src="/assets/images/help/classroom/assignments-import-starter-assignment.png">
</div>
#### Naming the assignment
For an individual assignment, {% data variables.product.prodname_classroom %} names repositories by the repository prefix and the student's {% data variables.product.product_name %} username. By default, the repository prefix is the assignment title. For example, if you name an assignment "assignment-1" and the student's username on {% data variables.product.product_name %} is @octocat, the name of the assignment repository for @octocat will be `assignment-1-octocat`.
{% data reusables.classroom.assignments-type-a-title %}
#### Assigning a deadline for an assignment
{% data reusables.classroom.assignments-guide-assign-a-deadline %}
#### Choosing a visibility for assignment repositories
The repositories for an assignment can be public or private. If you use private repositories, only the student can see the feedback you provide. Under "Repository visibility," select a visibility.
When you're done, click **Continue**. {% data variables.product.prodname_classroom %} will create the assignment and bring you to the assignment page.
<div class="procedural-image-wrapper">
<img alt="'Continue' button" class="procedural-image-wrapper" src="/assets/images/help/classroom/assignments-click-continue-button.png">
</div>
### Inviting students to an assignment
{% data reusables.classroom.assignments-guide-invite-students-to-assignment %}
You can see whether a student has joined the classroom and accepted or submitted an assignment in the **All students** tab for the assignment. {% data reusables.classroom.assignments-to-prevent-submission %}
<div class="procedural-image-wrapper">
<img alt="Individual assignment" class="procedural-image-wrapper" src="/assets/images/help/classroom/assignment-individual-hero.png">
</div>
The Git & {% data variables.product.company_short %} starter assignment is only available for individual students, not for groups. Once you create the assignment, students can start work on the assignment.
### Next steps
- Make additional assignments customized to your course. For more information, see "[Create an individual assignment](/education/manage-coursework-with-github-classroom/create-an-individual-assignment)" and "[Create a group assignment](/education/manage-coursework-with-github-classroom/create-a-group-assignment)."
### Further reading
- "[Use {% data variables.product.prodname_dotcom %} in your classroom and research](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-in-your-classroom-and-research)"
- "[Connect a learning management system to {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom/connect-a-learning-management-system-to-github-classroom)"

1
content/education/quickstart.md
View File

@@ -85,6 +85,7 @@ You've created a classroom, and you're ready to enrich your course with {% data
- Watch some videos about {% data variables.product.prodname_classroom %}. For more information, see "[Basics of setting up {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom/basics-of-setting-up-github-classroom)."
- Manage your classrooms and classroom admins, and create a roster of students for your classroom. For more information, see "[Manage classrooms](/education/manage-coursework-with-github-classroom/manage-classrooms)."
- Use the Git and {% data variables.product.company_short %} starter assignment to give students an overview of Git and {% data variables.product.product_name %} fundamentals. For more information, see "[Use the Git and {% data variables.product.company_short %} starter assignment](/education/manage-coursework-with-github-classroom/use-the-git-and-github-starter-assignment)."
- Create an assignment for individual students or teams. {% data reusables.classroom.for-more-information-about-assignment-creation %}
- Write and implement automated tests to provide immediate feedback to students directly in assignment repositories. For more information, see "[Use autograding](/education/manage-coursework-with-github-classroom/use-autograding)."
- Participate in {% data variables.product.prodname_education_community_with_url %}.

1
content/github/authenticating-to-github/keeping-your-account-and-data-secure/reviewing-your-security-log.md
View File

@@ -194,6 +194,7 @@ An overview of some of the most common actions that are recorded as events in th
| `repo_funding_links_file_action` | Triggered when you change the FUNDING file in your repository (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)")
| `sponsor_sponsorship_cancel` | Triggered when you cancel a sponsorship (see "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)")
| `sponsor_sponsorship_create` | Triggered when you sponsor an account (see "[Sponsoring an open source contributor](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor)")
| `sponsor_sponsorship_payment_complete` | Triggered after you sponsor an account and your payment has been processed (see "[Sponsoring an open source contributor](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor)")
| `sponsor_sponsorship_preference_change` | Triggered when you change whether you receive email updates from a sponsored developer (see "[Managing your sponsorship](/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship)")
| `sponsor_sponsorship_tier_change` | Triggered when you upgrade or downgrade your sponsorship (see "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)" and "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)")
| `sponsored_developer_approve` | Triggered when your {% data variables.product.prodname_sponsors %} account is approved (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)")

1
content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md
View File

@@ -643,6 +643,7 @@ For more information, see "[Managing the publication of {% data variables.produc
| `repo_funding_links_file_action` | Triggered when you change the FUNDING file in your repository (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)")
| `sponsor_sponsorship_cancel` | Triggered when you cancel a sponsorship (see "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)")
| `sponsor_sponsorship_create` | Triggered when you sponsor an account (see "[Sponsoring an open source contributor](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor)")
| `sponsor_sponsorship_payment_complete` | Triggered after you sponsor an account and your payment has been processed (see "[Sponsoring an open source contributor](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor)")
| `sponsor_sponsorship_preference_change` | Triggered when you change whether you receive email updates from a sponsored account (see "[Managing your sponsorship](/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship)")
| `sponsor_sponsorship_tier_change` | Triggered when you upgrade or downgrade your sponsorship (see "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)" and "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)")
| `sponsored_developer_approve` | Triggered when your {% data variables.product.prodname_sponsors %} account is approved (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)")

20
data/reusables/classroom/assignments-guide-create-the-assignment.md
View File

@@ -1,4 +1,22 @@
To create an assignment, sign into {% data variables.product.prodname_classroom_with_url %} and navigate to a classroom. In the {% octicon "repo" aria-label="The repo icon" %} **Assignments** tab, click **New assignment**.
#### If there are no existing assignments in the classroom
To create your first assignment:
1. Sign into {% data variables.product.prodname_classroom_with_url %}.
1. Navigate to a classroom.
1. In the {% octicon "repo" aria-label="The repo icon" %} **Assignments** tab, click **Create an assignment**.
<div class="procedural-image-wrapper">
<img alt="Creating your first assignment" class="procedural-image-wrapper" src="/assets/images/help/classroom/assignments-create-first-assignment.png">
</div>
#### If there already are existing assignments in the classroom
To create an assignment:
1. Sign into {% data variables.product.prodname_classroom_with_url %}.
1. Navigate to a classroom.
1. In the {% octicon "repo" aria-label="The repo icon" %} **Assignments** tab, click **New assignment**.
<div class="procedural-image-wrapper">
<img alt="The 'New assignment' button" class="procedural-image-wrapper" src="/assets/images/help/classroom/assignments-click-new-assignment-button.png">

2
data/reusables/secret-scanning/partner-secret-list-private-repo.md
View File

@@ -166,6 +166,8 @@ Stripe | Stripe Live API Restricted Key | stripe_live_restricted_key{% endif %}
Stripe | Stripe Test API Restricted Key | stripe_test_restricted_key{% endif %}
{%- if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}
Stripe | Stripe Webhook Signing Secret | stripe_webhook_signing_secret{% endif %}
{%- if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}
Telegram | Telegram Bot Token | telegram_bot_token{% endif %}
{%- if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@next" %}
Tencent Cloud | Tencent Cloud Secret ID | tencent_cloud_secret_id{% endif %}
{%- if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@next" %}

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

@@ -1,3 +1,3 @@
Key | Type | Description
----|------|-------------
`action` |`string` | The action that was performed. This can be one of `created`, `cancelled`, `edited`, `tier_changed`, `pending_cancellation`, or `pending_tier_change`.
`action` |`string` | The action that was performed. This can be one of `created`, `cancelled`, `edited`, `tier_changed`, `pending_cancellation`, or `pending_tier_change`. Note: The `created` action is only triggered after payment is processed.

813
lib/rest/static/decorated/github.ae.json
View File

@@ -8049,92 +8049,6 @@
"bodyParameters": [],
"descriptionHTML": "<p>Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
},
{
"verb": "get",
"requestPath": "/events",
"serverUrl": "http(s)://api.{hostname}",
"parameters": [
{
"name": "per_page",
"description": "Results per page (max 100).",
"in": "query",
"schema": {
"type": "integer",
"default": 30
},
"descriptionHTML": "<p>Results per page (max 100).</p>"
},
{
"name": "page",
"description": "Page number of the results to fetch.",
"in": "query",
"schema": {
"type": "integer",
"default": 1
},
"descriptionHTML": "<p>Page number of the results to fetch.</p>"
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/events",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/events</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('GET /events')",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /events'</span>)\n</code></pre>"
}
],
"summary": "List public events",
"description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.",
"tags": [
"activity"
],
"operationId": "activity/list-public-events",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/activity#list-public-events"
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"previews": [],
"category": "activity",
"subcategory": "events"
},
"slug": "list-public-events",
"category": "activity",
"categoryLabel": "Activity",
"subcategory": "events",
"subcategoryLabel": "Events",
"notes": [],
"responses": [
{
"httpStatusCode": "200",
"httpStatusMessage": "OK",
"description": "Response"
},
{
"httpStatusCode": "304",
"httpStatusMessage": "Not Modified",
"description": "Not modified"
},
{
"httpStatusCode": "403",
"httpStatusMessage": "Forbidden",
"description": "Forbidden"
},
{
"httpStatusCode": "503",
"httpStatusMessage": "Service Unavailable",
"description": "Service unavailable"
}
],
"bodyParameters": [],
"descriptionHTML": "<p>We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.</p>"
},
{
"verb": "get",
"requestPath": "/feeds",
@@ -10995,115 +10909,6 @@
}
]
},
{
"verb": "get",
"requestPath": "/networks/{owner}/{repo}/events",
"serverUrl": "http(s)://api.{hostname}",
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "per_page",
"description": "Results per page (max 100).",
"in": "query",
"schema": {
"type": "integer",
"default": 30
},
"descriptionHTML": "<p>Results per page (max 100).</p>"
},
{
"name": "page",
"description": "Page number of the results to fetch.",
"in": "query",
"schema": {
"type": "integer",
"default": 1
},
"descriptionHTML": "<p>Page number of the results to fetch.</p>"
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/networks/octocat/hello-world/events",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/networks/octocat/hello-world/events</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('GET /networks/{owner}/{repo}/events', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /networks/{owner}/{repo}/events'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>\n})\n</code></pre>"
}
],
"summary": "List public events for a network of repositories",
"description": "",
"tags": [
"activity"
],
"operationId": "activity/list-public-events-for-repo-network",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/activity#list-public-events-for-a-network-of-repositories"
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"previews": [],
"category": "activity",
"subcategory": "events"
},
"slug": "list-public-events-for-a-network-of-repositories",
"category": "activity",
"categoryLabel": "Activity",
"subcategory": "events",
"subcategoryLabel": "Events",
"notes": [],
"responses": [
{
"httpStatusCode": "200",
"httpStatusMessage": "OK",
"description": "Response"
},
{
"httpStatusCode": "301",
"httpStatusMessage": "Moved Permanently",
"description": "Moved permanently"
},
{
"httpStatusCode": "304",
"httpStatusMessage": "Not Modified",
"description": "Not modified"
},
{
"httpStatusCode": "403",
"httpStatusMessage": "Forbidden",
"description": "Forbidden"
},
{
"httpStatusCode": "404",
"httpStatusMessage": "Not Found",
"description": "Resource not found"
}
],
"bodyParameters": [],
"descriptionHTML": ""
},
{
"verb": "get",
"requestPath": "/notifications",
@@ -14483,86 +14288,6 @@
"bodyParameters": [],
"descriptionHTML": "<p>Removes a repository from an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/github-ae@latest/rest/reference/actions#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>"
},
{
"verb": "get",
"requestPath": "/orgs/{org}/events",
"serverUrl": "http(s)://api.{hostname}",
"parameters": [
{
"name": "org",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "per_page",
"description": "Results per page (max 100).",
"in": "query",
"schema": {
"type": "integer",
"default": 30
},
"descriptionHTML": "<p>Results per page (max 100).</p>"
},
{
"name": "page",
"description": "Page number of the results to fetch.",
"in": "query",
"schema": {
"type": "integer",
"default": 1
},
"descriptionHTML": "<p>Page number of the results to fetch.</p>"
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/events",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/events</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('GET /orgs/{org}/events', {\n org: 'org'\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /orgs/{org}/events'</span>, {\n <span class=\"hljs-attr\">org</span>: <span class=\"hljs-string\">'org'</span>\n})\n</code></pre>"
}
],
"summary": "List public organization events",
"description": "",
"tags": [
"activity"
],
"operationId": "activity/list-public-org-events",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/activity#list-public-organization-events"
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"previews": [],
"category": "activity",
"subcategory": "events"
},
"slug": "list-public-organization-events",
"category": "activity",
"categoryLabel": "Activity",
"subcategory": "events",
"subcategoryLabel": "Events",
"notes": [],
"responses": [
{
"httpStatusCode": "200",
"httpStatusMessage": "OK",
"description": "Response"
}
],
"bodyParameters": [],
"descriptionHTML": ""
},
{
"verb": "get",
"requestPath": "/orgs/{org}/hooks",
@@ -17382,304 +17107,6 @@
}
]
},
{
"verb": "get",
"requestPath": "/orgs/{org}/public_members",
"serverUrl": "http(s)://api.{hostname}",
"parameters": [
{
"name": "org",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "per_page",
"description": "Results per page (max 100).",
"in": "query",
"schema": {
"type": "integer",
"default": 30
},
"descriptionHTML": "<p>Results per page (max 100).</p>"
},
{
"name": "page",
"description": "Page number of the results to fetch.",
"in": "query",
"schema": {
"type": "integer",
"default": 1
},
"descriptionHTML": "<p>Page number of the results to fetch.</p>"
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/public_members",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/public_members</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('GET /orgs/{org}/public_members', {\n org: 'org'\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /orgs/{org}/public_members'</span>, {\n <span class=\"hljs-attr\">org</span>: <span class=\"hljs-string\">'org'</span>\n})\n</code></pre>"
}
],
"summary": "List public organization members",
"description": "Members of an organization can choose to have their membership publicized or not.",
"tags": [
"orgs"
],
"operationId": "orgs/list-public-members",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#list-public-organization-members"
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"previews": [],
"category": "orgs",
"subcategory": "members"
},
"slug": "list-public-organization-members",
"category": "orgs",
"categoryLabel": "Orgs",
"subcategory": "members",
"subcategoryLabel": "Members",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Members of an organization can choose to have their membership publicized or not.</p>",
"responses": [
{
"httpStatusCode": "200",
"httpStatusMessage": "OK",
"description": "Response",
"payload": "<pre><code class=\"hljs language-json\">[\n {\n <span class=\"hljs-attr\">\"login\"</span>: <span class=\"hljs-string\">\"octocat\"</span>,\n <span class=\"hljs-attr\">\"id\"</span>: <span class=\"hljs-number\">1</span>,\n <span class=\"hljs-attr\">\"node_id\"</span>: <span class=\"hljs-string\">\"MDQ6VXNlcjE=\"</span>,\n <span class=\"hljs-attr\">\"avatar_url\"</span>: <span class=\"hljs-string\">\"https://github.com/images/error/octocat_happy.gif\"</span>,\n <span class=\"hljs-attr\">\"gravatar_id\"</span>: <span class=\"hljs-string\">\"\"</span>,\n <span class=\"hljs-attr\">\"url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat\"</span>,\n <span class=\"hljs-attr\">\"html_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat\"</span>,\n <span class=\"hljs-attr\">\"followers_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/followers\"</span>,\n <span class=\"hljs-attr\">\"following_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/following{/other_user}\"</span>,\n <span class=\"hljs-attr\">\"gists_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/gists{/gist_id}\"</span>,\n <span class=\"hljs-attr\">\"starred_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/starred{/owner}{/repo}\"</span>,\n <span class=\"hljs-attr\">\"subscriptions_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/subscriptions\"</span>,\n <span class=\"hljs-attr\">\"organizations_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/orgs\"</span>,\n <span class=\"hljs-attr\">\"repos_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/repos\"</span>,\n <span class=\"hljs-attr\">\"events_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/events{/privacy}\"</span>,\n <span class=\"hljs-attr\">\"received_events_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/received_events\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"User\"</span>,\n <span class=\"hljs-attr\">\"site_admin\"</span>: <span class=\"hljs-literal\">false</span>\n }\n]\n</code></pre>"
}
]
},
{
"verb": "get",
"requestPath": "/orgs/{org}/public_members/{username}",
"serverUrl": "http(s)://api.{hostname}",
"parameters": [
{
"name": "org",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "username",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/public_members/USERNAME",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/public_members/USERNAME</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('GET /orgs/{org}/public_members/{username}', {\n org: 'org',\n username: 'username'\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /orgs/{org}/public_members/{username}'</span>, {\n <span class=\"hljs-attr\">org</span>: <span class=\"hljs-string\">'org'</span>,\n <span class=\"hljs-attr\">username</span>: <span class=\"hljs-string\">'username'</span>\n})\n</code></pre>"
}
],
"summary": "Check public organization membership for a user",
"description": "",
"tags": [
"orgs"
],
"operationId": "orgs/check-public-membership-for-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#check-public-organization-membership-for-a-user"
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"previews": [],
"category": "orgs",
"subcategory": "members"
},
"slug": "check-public-organization-membership-for-a-user",
"category": "orgs",
"categoryLabel": "Orgs",
"subcategory": "members",
"subcategoryLabel": "Members",
"notes": [],
"responses": [
{
"httpStatusCode": "204",
"httpStatusMessage": "No Content",
"description": "Response if user is a public member"
},
{
"httpStatusCode": "404",
"httpStatusMessage": "Not Found",
"description": "Not Found if user is not a public member"
}
],
"bodyParameters": [],
"descriptionHTML": ""
},
{
"verb": "put",
"requestPath": "/orgs/{org}/public_members/{username}",
"serverUrl": "http(s)://api.{hostname}",
"parameters": [
{
"name": "org",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "username",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/public_members/USERNAME",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/public_members/USERNAME</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('PUT /orgs/{org}/public_members/{username}', {\n org: 'org',\n username: 'username'\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'PUT /orgs/{org}/public_members/{username}'</span>, {\n <span class=\"hljs-attr\">org</span>: <span class=\"hljs-string\">'org'</span>,\n <span class=\"hljs-attr\">username</span>: <span class=\"hljs-string\">'username'</span>\n})\n</code></pre>"
}
],
"summary": "Set public organization membership for the authenticated user",
"description": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs).\"",
"tags": [
"orgs"
],
"operationId": "orgs/set-public-membership-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#set-public-organization-membership-for-the-authenticated-user"
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": false,
"previews": [],
"category": "orgs",
"subcategory": "members"
},
"slug": "set-public-organization-membership-for-the-authenticated-user",
"category": "orgs",
"categoryLabel": "Orgs",
"subcategory": "members",
"subcategoryLabel": "Members",
"notes": [],
"responses": [
{
"httpStatusCode": "204",
"httpStatusMessage": "No Content",
"description": "Response"
},
{
"httpStatusCode": "403",
"httpStatusMessage": "Forbidden",
"description": "Forbidden"
}
],
"bodyParameters": [],
"descriptionHTML": "<p>The user can publicize their own membership. (A user cannot publicize the membership for another user.)</p>\n<p>Note that you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>"
},
{
"verb": "delete",
"requestPath": "/orgs/{org}/public_members/{username}",
"serverUrl": "http(s)://api.{hostname}",
"parameters": [
{
"name": "org",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "username",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/public_members/USERNAME",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/orgs/ORG/public_members/USERNAME</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('DELETE /orgs/{org}/public_members/{username}', {\n org: 'org',\n username: 'username'\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'DELETE /orgs/{org}/public_members/{username}'</span>, {\n <span class=\"hljs-attr\">org</span>: <span class=\"hljs-string\">'org'</span>,\n <span class=\"hljs-attr\">username</span>: <span class=\"hljs-string\">'username'</span>\n})\n</code></pre>"
}
],
"summary": "Remove public organization membership for the authenticated user",
"description": "",
"tags": [
"orgs"
],
"operationId": "orgs/remove-public-membership-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#remove-public-organization-membership-for-the-authenticated-user"
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": false,
"previews": [],
"category": "orgs",
"subcategory": "members"
},
"slug": "remove-public-organization-membership-for-the-authenticated-user",
"category": "orgs",
"categoryLabel": "Orgs",
"subcategory": "members",
"subcategoryLabel": "Members",
"notes": [],
"responses": [
{
"httpStatusCode": "204",
"httpStatusMessage": "No Content",
"description": "Response"
}
],
"bodyParameters": [],
"descriptionHTML": ""
},
{
"verb": "get",
"requestPath": "/orgs/{org}/repos",
@@ -74720,86 +74147,6 @@
"bodyParameters": [],
"descriptionHTML": "<p>This is the user's organization dashboard. You must be authenticated as the user to view this.</p>"
},
{
"verb": "get",
"requestPath": "/users/{username}/events/public",
"serverUrl": "http(s)://api.{hostname}",
"parameters": [
{
"name": "username",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "per_page",
"description": "Results per page (max 100).",
"in": "query",
"schema": {
"type": "integer",
"default": 30
},
"descriptionHTML": "<p>Results per page (max 100).</p>"
},
{
"name": "page",
"description": "Page number of the results to fetch.",
"in": "query",
"schema": {
"type": "integer",
"default": 1
},
"descriptionHTML": "<p>Page number of the results to fetch.</p>"
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/users/USERNAME/events/public",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/users/USERNAME/events/public</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('GET /users/{username}/events/public', {\n username: 'username'\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /users/{username}/events/public'</span>, {\n <span class=\"hljs-attr\">username</span>: <span class=\"hljs-string\">'username'</span>\n})\n</code></pre>"
}
],
"summary": "List public events for a user",
"description": "",
"tags": [
"activity"
],
"operationId": "activity/list-public-events-for-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/activity#list-public-events-for-a-user"
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"previews": [],
"category": "activity",
"subcategory": "events"
},
"slug": "list-public-events-for-a-user",
"category": "activity",
"categoryLabel": "Activity",
"subcategory": "events",
"subcategoryLabel": "Events",
"notes": [],
"responses": [
{
"httpStatusCode": "200",
"httpStatusMessage": "OK",
"description": "Response"
}
],
"bodyParameters": [],
"descriptionHTML": ""
},
{
"verb": "get",
"requestPath": "/users/{username}/followers",
@@ -75638,166 +74985,6 @@
}
]
},
{
"verb": "get",
"requestPath": "/users/{username}/received_events",
"serverUrl": "http(s)://api.{hostname}",
"parameters": [
{
"name": "username",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "per_page",
"description": "Results per page (max 100).",
"in": "query",
"schema": {
"type": "integer",
"default": 30
},
"descriptionHTML": "<p>Results per page (max 100).</p>"
},
{
"name": "page",
"description": "Page number of the results to fetch.",
"in": "query",
"schema": {
"type": "integer",
"default": 1
},
"descriptionHTML": "<p>Page number of the results to fetch.</p>"
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/users/USERNAME/received_events",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/users/USERNAME/received_events</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('GET /users/{username}/received_events', {\n username: 'username'\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /users/{username}/received_events'</span>, {\n <span class=\"hljs-attr\">username</span>: <span class=\"hljs-string\">'username'</span>\n})\n</code></pre>"
}
],
"summary": "List events received by the authenticated user",
"description": "These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.",
"tags": [
"activity"
],
"operationId": "activity/list-received-events-for-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/activity#list-events-received-by-the-authenticated-user"
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"previews": [],
"category": "activity",
"subcategory": "events"
},
"slug": "list-events-received-by-the-authenticated-user",
"category": "activity",
"categoryLabel": "Activity",
"subcategory": "events",
"subcategoryLabel": "Events",
"notes": [],
"responses": [
{
"httpStatusCode": "200",
"httpStatusMessage": "OK",
"description": "Response"
}
],
"bodyParameters": [],
"descriptionHTML": "<p>These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.</p>"
},
{
"verb": "get",
"requestPath": "/users/{username}/received_events/public",
"serverUrl": "http(s)://api.{hostname}",
"parameters": [
{
"name": "username",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "per_page",
"description": "Results per page (max 100).",
"in": "query",
"schema": {
"type": "integer",
"default": 30
},
"descriptionHTML": "<p>Results per page (max 100).</p>"
},
{
"name": "page",
"description": "Page number of the results to fetch.",
"in": "query",
"schema": {
"type": "integer",
"default": 1
},
"descriptionHTML": "<p>Page number of the results to fetch.</p>"
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/users/USERNAME/received_events/public",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://api.{hostname}/users/USERNAME/received_events/public</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('GET /users/{username}/received_events/public', {\n username: 'username'\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /users/{username}/received_events/public'</span>, {\n <span class=\"hljs-attr\">username</span>: <span class=\"hljs-string\">'username'</span>\n})\n</code></pre>"
}
],
"summary": "List public events received by a user",
"description": "",
"tags": [
"activity"
],
"operationId": "activity/list-received-public-events-for-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/activity#list-public-events-received-by-a-user"
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"previews": [],
"category": "activity",
"subcategory": "events"
},
"slug": "list-public-events-received-by-a-user",
"category": "activity",
"categoryLabel": "Activity",
"subcategory": "events",
"subcategoryLabel": "Events",
"notes": [],
"responses": [
{
"httpStatusCode": "200",
"httpStatusMessage": "OK",
"description": "Response"
}
],
"bodyParameters": [],
"descriptionHTML": ""
},
{
"verb": "get",
"requestPath": "/users/{username}/repos",

17531
lib/rest/static/dereferenced/github.ae.deref.json
View File

File diff suppressed because it is too large Load Diff