`. For example, `octo-org/another-repo/.github/workflows/workflow.yml@v1`. For more information, see "[Reusing workflows](/actions/using-workflows/reusing-workflows#calling-a-reusable-workflow)."
+ {%- endif %}
- You can use the `*` wildcard character to match patterns. For example, to allow all actions in organizations that start with `space-org`, you can specify `space-org*/*`. To add all actions in repositories that start with octocat, you can use `*/octocat*@*`. For more information about using the `*` wildcard, see "[Workflow syntax for GitHub Actions](/actions/reference/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet)."
+ You can use the `*` wildcard character to match patterns. For example, to allow all actions{% if actions-workflow-policy %} and reusable workflows{% endif %} in organizations that start with `space-org`, you can specify `space-org*/*`. To allow all actions{% if actions-workflow-policy %} and reusable workflows{% endif %} in repositories that start with octocat, you can use `*/octocat**@*`. For more information about using the `*` wildcard, see "[Workflow syntax for GitHub Actions](/actions/reference/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet)."
{% ifversion fpt or ghec %}
{% note %}
- **Note:** The **Allow specified actions** option is only available in public repositories with the {% data variables.product.prodname_free_user %}, {% data variables.product.prodname_pro %}, {% data variables.product.prodname_free_team %} for organizations, or {% data variables.product.prodname_team %} plan.
+ **Note:** The **Allow specified actions{% if actions-workflow-policy %} and reusable workflows{% endif %}** option is only available in public repositories with the {% data variables.product.prodname_free_user %}, {% data variables.product.prodname_pro %}, {% data variables.product.prodname_free_team %} for organizations, or {% data variables.product.prodname_team %} plan.
{% endnote %}
{% endif %}
-This procedure demonstrates how to add specific actions to the allow list.
+This procedure demonstrates how to add specific actions{% if actions-workflow-policy %} and reusable workflows{% endif %} to the allow list.
diff --git a/data/reusables/actions/disabling-github-actions.md b/data/reusables/actions/disabling-github-actions.md
index 36ff04ab4ed6..a201730ffd89 100644
--- a/data/reusables/actions/disabling-github-actions.md
+++ b/data/reusables/actions/disabling-github-actions.md
@@ -1 +1 @@
-By default, {% ifversion ghes or ghae %}after {% data variables.product.prodname_actions %} is enabled on {% data variables.product.product_location %}, it{% elsif fpt or ghec %}{% data variables.product.prodname_actions %}{% endif %} is enabled on all repositories and organizations. You can choose to disable {% data variables.product.prodname_actions %} or limit them to local actions only, which means that people can only use actions that exist in your repository.
+By default, {% ifversion ghes or ghae %}after {% data variables.product.prodname_actions %} is enabled on {% data variables.product.product_location %}, it{% elsif fpt or ghec %}{% data variables.product.prodname_actions %}{% endif %} is enabled on all repositories and organizations. You can choose to disable {% data variables.product.prodname_actions %} or limit it to actions {% if actions-workflow-policy %}and reusable workflows{% endif %} in your {% ifversion ghec or ghes or ghae %}enterprise{% else %}organization{% endif %}.
diff --git a/data/reusables/actions/enabled-actions-description.md b/data/reusables/actions/enabled-actions-description.md
index 3f5092e9cab9..06c942883a12 100644
--- a/data/reusables/actions/enabled-actions-description.md
+++ b/data/reusables/actions/enabled-actions-description.md
@@ -1 +1 @@
-When you enable {% data variables.product.prodname_actions %}, workflows are able to run actions located within your repository and any other{% ifversion fpt %} public{% elsif ghec or ghes %} public or internal{% elsif ghae %} internal{% endif %} repository.
+When you enable {% data variables.product.prodname_actions %}, workflows are able to run actions {% if actions-workflow-policy %}and reusable workflows{% endif %} located within your repository and any other{% ifversion fpt %} public{% elsif ghec or ghes %} public or internal{% elsif ghae %} internal{% endif %} repository.
diff --git a/data/reusables/actions/enabled-local-github-actions.md b/data/reusables/actions/enabled-local-github-actions.md
deleted file mode 100644
index 0043c8e9608d..000000000000
--- a/data/reusables/actions/enabled-local-github-actions.md
+++ /dev/null
@@ -1 +0,0 @@
-When you enable local actions only, workflows can only run actions located in your repository, organization, or enterprise.
diff --git a/data/reusables/actions/enterprise-actions-permissions.md b/data/reusables/actions/enterprise-actions-permissions.md
deleted file mode 100644
index c13bfc4905df..000000000000
--- a/data/reusables/actions/enterprise-actions-permissions.md
+++ /dev/null
@@ -1,12 +0,0 @@
-1. Under "Policies", select your options.
-
- You can choose which organizations in your enterprise can use {% data variables.product.prodname_actions %}, and you can restrict access to public actions.
-
- {% ifversion ghes %}
- {% note %}
-
- **Note:** To enable access to public actions, you must first configure {% data variables.product.product_location %} to connect to {% data variables.product.prodname_marketplace %}. For more information, see "[Enabling automatic access to GitHub.com actions using GitHub Connect](/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)."
-
- {% endnote %}
- {% endif %}
- 
diff --git a/data/reusables/actions/policy-label-for-select-actions-workflows.md b/data/reusables/actions/policy-label-for-select-actions-workflows.md
new file mode 100644
index 000000000000..2f7d6c623941
--- /dev/null
+++ b/data/reusables/actions/policy-label-for-select-actions-workflows.md
@@ -0,0 +1 @@
+{% if actions-workflow-policy %}{% ifversion ghec or ghes or ghae %}**Allow enterprise, and select non-enterprise, actions and reusable workflows**{% else %}**Allow *OWNER*, and select non-*OWNER*, actions and reusable workflows**{% endif %}{% else %}**Allow select actions**{% endif %}
\ No newline at end of file
diff --git a/data/reusables/billing/overages-billed-monthly.md b/data/reusables/billing/overages-billed-monthly.md
new file mode 100644
index 000000000000..3b87ec1dc79f
--- /dev/null
+++ b/data/reusables/billing/overages-billed-monthly.md
@@ -0,0 +1 @@
+Overages are always billed monthly regardless of your billing term (even if your account is otherwise billed annually).
\ No newline at end of file
diff --git a/data/reusables/codespaces/codespaces-spending-limit-requirement.md b/data/reusables/codespaces/codespaces-spending-limit-requirement.md
index a91b3595d324..105960fe1396 100644
--- a/data/reusables/codespaces/codespaces-spending-limit-requirement.md
+++ b/data/reusables/codespaces/codespaces-spending-limit-requirement.md
@@ -5,3 +5,5 @@
{% endnote %}
By default, your organization or enterprise will have a {% data variables.product.prodname_codespaces %} spending limit of $0, which prevents new codespaces from being created or existing codespaces from being opened. To allow your users to create codespaces in your organization, set the limit to a value higher than $0.
+
+{% data reusables.billing.overages-billed-monthly %}
\ No newline at end of file
diff --git a/data/reusables/dependabot/beta-security-and-version-updates.md b/data/reusables/dependabot/beta-security-and-version-updates.md
index f92d10927d03..948349fcb429 100644
--- a/data/reusables/dependabot/beta-security-and-version-updates.md
+++ b/data/reusables/dependabot/beta-security-and-version-updates.md
@@ -1,11 +1,21 @@
-{% ifversion ghes > 3.2 %}
+{% ifversion ghes > 3.2 and ghes < 3.5 %}
{% note %}
-{% if dependabot-updates-github-connect %}
+{% ifversion ghes = 3.4 %}
**Note:** {% data variables.product.prodname_dependabot %} security and version updates are currently in public beta and subject to change.
{% else %}
**Note:** {% data variables.product.prodname_dependabot %} security and version updates are currently in private beta and subject to change. Please [contact your account management team](https://enterprise.github.com/contact) for instructions on enabling Dependabot updates.
{% endif %}
+
{% endnote %}
{% endif %}
+
+{% ifversion ghae-issue-5867 %}
+
+{% note %}
+
+**Note:** {% data variables.product.prodname_dependabot %} security and version updates are currently in public beta and subject to change.
+
+{% endnote %}
+{% endif %}
diff --git a/data/reusables/dependabot/dependabot-alerts-dependency-graph-enterprise.md b/data/reusables/dependabot/dependabot-alerts-dependency-graph-enterprise.md
index 14d560b7e435..d5ae9b84157e 100644
--- a/data/reusables/dependabot/dependabot-alerts-dependency-graph-enterprise.md
+++ b/data/reusables/dependabot/dependabot-alerts-dependency-graph-enterprise.md
@@ -1,3 +1,3 @@
{% ifversion ghes or ghae-issue-4864 %}
-The dependency graph and {% data variables.product.prodname_dependabot_alerts %} are configured at an enterprise level by the enterprise owner. For more information, see {% ifversion ghes %}"[Enabling the dependency graph for your enterprise](/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise)" and {% endif %}"[Enabling {% data variables.product.prodname_dependabot %} for your enterprise](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)."
+Enterprise owners can configure {% ifversion ghes %}the dependency graph and {% endif %}{% data variables.product.prodname_dependabot_alerts %} for an enterprise. For more information, see {% ifversion ghes %}"[Enabling the dependency graph for your enterprise](/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise)" and {% endif %}"[Enabling {% data variables.product.prodname_dependabot %} for your enterprise](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)."
{% endif %}
diff --git a/data/reusables/dotcom_billing/actions-packages-report-download-org-account.md b/data/reusables/dotcom_billing/actions-packages-report-download-org-account.md
new file mode 100644
index 000000000000..a537ca716285
--- /dev/null
+++ b/data/reusables/dotcom_billing/actions-packages-report-download-org-account.md
@@ -0,0 +1,2 @@
+1. Optionally, next to "Billing & plans", click **Get usage report** to email a CSV report of storage use for {% data variables.product.prodname_actions %}, {% data variables.product.prodname_registry %}, and {% data variables.product.prodname_codespaces %} to the account's primary email address.
+ 
diff --git a/data/reusables/dotcom_billing/codespaces-report-download.md b/data/reusables/dotcom_billing/codespaces-report-download.md
deleted file mode 100644
index 1a0dc1531608..000000000000
--- a/data/reusables/dotcom_billing/codespaces-report-download.md
+++ /dev/null
@@ -1,2 +0,0 @@
-1. Optionally, next to "Usage this month", click **Get usage report** to email a CSV report of storage use for {% data variables.product.prodname_codespaces %} to the account's primary email address.
- 
diff --git a/data/reusables/enterprise-accounts/actions-packages-report-download-enterprise-accounts.md b/data/reusables/enterprise-accounts/actions-packages-report-download-enterprise-accounts.md
index 27258bfe2b90..27ae24ec63b2 100644
--- a/data/reusables/enterprise-accounts/actions-packages-report-download-enterprise-accounts.md
+++ b/data/reusables/enterprise-accounts/actions-packages-report-download-enterprise-accounts.md
@@ -1,2 +1,2 @@
-1. Optionally, under "{% data variables.product.prodname_dotcom %} Actions and Packages monthly usage", click **Get usage report** to email a CSV report of storage use for {% data variables.product.prodname_actions %} and {% data variables.product.prodname_registry %} in each of your enterprise account's organizations to the primary email address for the account.
+1. Optionally, under the billing summary at the top of the page click **Get usage report** to email a CSV report of storage use for {% data variables.product.prodname_actions %}, {% data variables.product.prodname_registry %}, and {% data variables.product.prodname_codespaces %} in each of your enterprise account's organizations to the primary email address for the account.
diff --git a/data/reusables/mobile/about-mobile.md b/data/reusables/mobile/about-mobile.md
index 3f4846f7a9b9..a86df6773960 100644
--- a/data/reusables/mobile/about-mobile.md
+++ b/data/reusables/mobile/about-mobile.md
@@ -1 +1 @@
-{% data variables.product.prodname_mobile %} is available as an Android and iOS app. {% data variables.product.prodname_mobile %} is generally available for {% data variables.product.prodname_dotcom_the_website %} users and in public beta for users of {% data variables.product.prodname_ghe_server %} 3.0+.
+{% data variables.product.prodname_mobile %} is available as an Android and iOS app.
diff --git a/data/reusables/mobile/ghes-release-phase.md b/data/reusables/mobile/ghes-release-phase.md
deleted file mode 100644
index 57edb6b54aa5..000000000000
--- a/data/reusables/mobile/ghes-release-phase.md
+++ /dev/null
@@ -1,5 +0,0 @@
-{% note %}
-
-**Note:** {% data variables.product.prodname_mobile %} is currently in beta for {% data variables.product.prodname_ghe_server %} 3.0 and subject to change.
-
-{% endnote %}
diff --git a/data/reusables/package_registry/packages-spending-limit-detailed.md b/data/reusables/package_registry/packages-spending-limit-detailed.md
index 03cd903d2da6..4546527cdade 100644
--- a/data/reusables/package_registry/packages-spending-limit-detailed.md
+++ b/data/reusables/package_registry/packages-spending-limit-detailed.md
@@ -1,3 +1,5 @@
{% data reusables.package_registry.packages-spending-limit-brief %}
If you have an unlimited spending limit or a spending limit set higher than $0 USD, you will be billed for any additional storage or data transfer, also called overages, up to your spending limit. Any coupons on your account do not apply to {% data variables.product.prodname_registry %} overages.
+
+{% data reusables.billing.overages-billed-monthly %}
\ No newline at end of file
diff --git a/data/reusables/rest-reference/actions/permissions.md b/data/reusables/rest-reference/actions/permissions.md
index 41cabe9d20b7..6acc16385d4c 100644
--- a/data/reusables/rest-reference/actions/permissions.md
+++ b/data/reusables/rest-reference/actions/permissions.md
@@ -1,3 +1,3 @@
## Permissions
-The Permissions API allows you to set permissions for what enterprises, organizations, and repositories are allowed to run {% data variables.product.prodname_actions %}, and what actions are allowed to run.{% ifversion fpt or ghec or ghes %} For more information, see "[Usage limits, billing, and administration](/actions/reference/usage-limits-billing-and-administration#disabling-or-limiting-github-actions-for-your-repository-or-organization)."{% endif %}
\ No newline at end of file
+The Permissions API allows you to set permissions for what enterprises, organizations, and repositories are allowed to run {% data variables.product.prodname_actions %}, and what actions{% if actions-workflow-policy %} and reusable workflows{% endif %} are allowed to run.{% ifversion fpt or ghec or ghes %} For more information, see "[Usage limits, billing, and administration](/actions/reference/usage-limits-billing-and-administration#disabling-or-limiting-github-actions-for-your-repository-or-organization)."{% endif %}
\ No newline at end of file
diff --git a/data/reusables/secret-scanning/partner-secret-list-private-repo.md b/data/reusables/secret-scanning/partner-secret-list-private-repo.md
index 52e08b7ea9a7..5f43d7c3a4d2 100644
--- a/data/reusables/secret-scanning/partner-secret-list-private-repo.md
+++ b/data/reusables/secret-scanning/partner-secret-list-private-repo.md
@@ -17,9 +17,9 @@ Amazon | Amazon OAuth Client ID | amazon_oauth_client_id{% endif %}
Amazon | Amazon OAuth Client Secret | amazon_oauth_client_secret{% endif %}
Amazon Web Services (AWS) | Amazon AWS Access Key ID | aws_access_key_id
Amazon Web Services (AWS) | Amazon AWS Secret Access Key | aws_secret_access_key
-{%- ifversion fpt or ghec or ghes > 3.2 %}
+{%- ifversion fpt or ghec or ghes > 3.2 or ghae-issue-5844 %}
Amazon Web Services (AWS) | Amazon AWS Session Token | aws_session_token{% endif %}
-{%- ifversion fpt or ghec or ghes > 3.2 %}
+{%- ifversion fpt or ghec or ghes > 3.2 or ghae-issue-5844 %}
Amazon Web Services (AWS) | Amazon AWS Temporary Access Key ID | aws_temporary_access_key_id{% endif %}
{%- ifversion fpt or ghec or ghes > 3.1 or ghae %}
Asana | Asana Personal Access Token | asana_personal_access_token{% endif %}
@@ -37,7 +37,7 @@ Azure | Azure Service Management Certificate | azure_management_certificate
{%- ifversion ghes < 3.4 or ghae or ghae-issue-5342 %}
Azure | Azure SQL Connection String | azure_sql_connection_string{% endif %}
Azure | Azure Storage Account Key | azure_storage_account_key
-{%- ifversion fpt or ghec or ghes > 3.2 %}
+{%- ifversion fpt or ghec or ghes > 3.2 or ghae-issue-5844 %}
Beamer | Beamer API Key | beamer_api_key{% endif %}
{%- ifversion fpt or ghec or ghes > 3.1 or ghae %}
Checkout.com | Checkout.com Production Secret Key | checkout_production_secret_key{% endif %}
@@ -46,7 +46,7 @@ Checkout.com | Checkout.com Test Secret Key | checkout_test_secret_key{% endif %
Clojars | Clojars Deploy Token | clojars_deploy_token
{%- ifversion fpt or ghec or ghes > 3.1 or ghae %}
CloudBees CodeShip | CloudBees CodeShip Credential | codeship_credential{% endif %}
-{%- ifversion fpt or ghec or ghes > 3.2 %}
+{%- ifversion fpt or ghec or ghes > 3.2 or ghae-issue-5844 %}
Contentful | Contentful Personal Access Token | contentful_personal_access_token{% endif %}
Databricks | Databricks Access Token | databricks_access_token
Discord | Discord Bot Token | discord_bot_token
@@ -77,7 +77,7 @@ Flutterwave | Flutterwave Live API Secret Key | flutterwave_live_api_secret_key{
Flutterwave | Flutterwave Test API Secret Key | flutterwave_test_api_secret_key{% endif %}
Frame.io | Frame.io JSON Web Token | frameio_jwt
Frame.io| Frame.io Developer Token | frameio_developer_token
-{%- ifversion fpt or ghec or ghes > 3.2 %}
+{%- ifversion fpt or ghec or ghes > 3.2 or ghae-issue-5844 %}
FullStory | FullStory API Key | fullstory_api_key{% endif %}
{%- ifversion fpt or ghec or ghes > 3.1 or ghae %}
GitHub | GitHub Personal Access Token | github_personal_access_token{% endif %}
@@ -92,15 +92,15 @@ GitHub | GitHub SSH Private Key | github_ssh_private_key
GitLab | GitLab Access Token | gitlab_access_token{% endif %}
GoCardless | GoCardless Live Access Token | gocardless_live_access_token
GoCardless | GoCardless Sandbox Access Token | gocardless_sandbox_access_token
-{%- ifversion fpt or ghec or ghes > 3.2 %}
+{%- ifversion fpt or ghec or ghes > 3.2 or ghae-issue-5844 %}
Google | Firebase Cloud Messaging Server Key | firebase_cloud_messaging_server_key{% endif %}
Google | Google API Key | google_api_key
Google | Google Cloud Private Key ID | google_cloud_private_key_id
-{%- ifversion fpt or ghec or ghes > 3.2 %}
+{%- ifversion fpt or ghec or ghes > 3.2 or ghae-issue-5844 %}
Google | Google Cloud Storage Access Key Secret | google_cloud_storage_access_key_secret{% endif %}
-{%- ifversion fpt or ghec or ghes > 3.2 %}
+{%- ifversion fpt or ghec or ghes > 3.2 or ghae-issue-5844 %}
Google | Google Cloud Storage Service Account Access Key ID | google_cloud_storage_service_account_access_key_id{% endif %}
-{%- ifversion fpt or ghec or ghes > 3.2 %}
+{%- ifversion fpt or ghec or ghes > 3.2 or ghae-issue-5844 %}
Google | Google Cloud Storage User Access Key ID | google_cloud_storage_user_access_key_id{% endif %}
{%- ifversion fpt or ghec or ghes > 3.3 %}
Google | Google OAuth Access Token | google_oauth_access_token{% endif %}
@@ -124,9 +124,9 @@ Ionic | Ionic Personal Access Token | ionic_personal_access_token{% endif %}
Ionic | Ionic Refresh Token | ionic_refresh_token{% endif %}
{%- ifversion fpt or ghec or ghes > 3.4 %}
JD Cloud | JD Cloud Access Key | jd_cloud_access_key{% endif %}
-{%- ifversion fpt or ghec or ghes > 3.2 %}
+{%- ifversion fpt or ghec or ghes > 3.2 or ghae-issue-5844 %}
JFrog | JFrog Platform Access Token | jfrog_platform_access_token{% endif %}
-{%- ifversion fpt or ghec or ghes > 3.2 %}
+{%- ifversion fpt or ghec or ghes > 3.2 or ghae-issue-5844 %}
JFrog | JFrog Platform API Key | jfrog_platform_api_key{% endif %}
{%- ifversion fpt or ghec or ghes > 3.1 or ghae %}
Linear | Linear API Key | linear_api_key{% endif %}
@@ -148,13 +148,13 @@ Meta | Facebook Access Token | facebook_access_token{% endif %}
Midtrans | Midtrans Production Server Key | midtrans_production_server_key{% endif %}
{%- ifversion fpt or ghec or ghes > 3.3 %}
Midtrans | Midtrans Sandbox Server Key | midtrans_sandbox_server_key{% endif %}
-{%- ifversion fpt or ghec or ghes > 3.2 %}
+{%- ifversion fpt or ghec or ghes > 3.2 or ghae-issue-5844 %}
New Relic | New Relic Personal API Key | new_relic_personal_api_key{% endif %}
-{%- ifversion fpt or ghec or ghes > 3.2 %}
+{%- ifversion fpt or ghec or ghes > 3.2 or ghae-issue-5844 %}
New Relic | New Relic REST API Key | new_relic_rest_api_key{% endif %}
-{%- ifversion fpt or ghec or ghes > 3.2 %}
+{%- ifversion fpt or ghec or ghes > 3.2 or ghae-issue-5844 %}
New Relic | New Relic Insights Query Key | new_relic_insights_query_key{% endif %}
-{%- ifversion fpt or ghec or ghes > 3.2 %}
+{%- ifversion fpt or ghec or ghes > 3.2 or ghae-issue-5844 %}
New Relic | New Relic License Key | new_relic_license_key{% endif %}
{%- ifversion fpt or ghec or ghes > 3.3 %}
Notion | Notion Integration Token | notion_integration_token{% endif %}
@@ -171,15 +171,15 @@ Onfido | Onfido Sandbox API Token | onfido_sandbox_api_token{% endif %}
{%- ifversion fpt or ghec or ghes > 3.1 or ghae %}
OpenAI | OpenAI API Key | openai_api_key{% endif %}
Palantir | Palantir JSON Web Token | palantir_jwt
-{%- ifversion fpt or ghec or ghes > 3.2 %}
+{%- ifversion fpt or ghec or ghes > 3.2 or ghae-issue-5844 %}
PlanetScale | PlanetScale Database Password | planetscale_database_password{% endif %}
-{%- ifversion fpt or ghec or ghes > 3.2 %}
+{%- ifversion fpt or ghec or ghes > 3.2 or ghae-issue-5844 %}
PlanetScale | PlanetScale OAuth Token | planetscale_oauth_token{% endif %}
-{%- ifversion fpt or ghec or ghes > 3.2 %}
+{%- ifversion fpt or ghec or ghes > 3.2 or ghae-issue-5844 %}
PlanetScale | PlanetScale Service Token | planetscale_service_token{% endif %}
-{%- ifversion fpt or ghec or ghes > 3.2 %}
+{%- ifversion fpt or ghec or ghes > 3.2 or ghae-issue-5844 %}
Plivo | Plivo Auth ID | plivo_auth_id{% endif %}
-{%- ifversion fpt or ghec or ghes > 3.2 %}
+{%- ifversion fpt or ghec or ghes > 3.2 or ghae-issue-5844 %}
Plivo | Plivo Auth Token | plivo_auth_token{% endif %}
Postman | Postman API Key | postman_api_key
Proctorio | Proctorio Consumer Key | proctorio_consumer_key
@@ -197,9 +197,9 @@ Samsara | Samsara OAuth Access Token | samsara_oauth_access_token
Segment | Segment Public API Token | segment_public_api_token{% endif %}
{%- ifversion fpt or ghec or ghes > 3.1 or ghae %}
SendGrid | SendGrid API Key | sendgrid_api_key{% endif %}
-{%- ifversion fpt or ghec or ghes > 3.2 %}
+{%- ifversion fpt or ghec or ghes > 3.2 or ghae-issue-5844 %}
Sendinblue | Sendinblue API Key | sendinblue_api_key{% endif %}
-{%- ifversion fpt or ghec or ghes > 3.2 %}
+{%- ifversion fpt or ghec or ghes > 3.2 or ghae-issue-5844 %}
Sendinblue | Sendinblue SMTP Key | sendinblue_smtp_key{% endif %}
{%- ifversion fpt or ghec or ghes > 3.1 or ghae %}
Shippo | Shippo Live API Token | shippo_live_api_token{% endif %}
diff --git a/data/reusables/secret-scanning/partner-secret-list-public-repo.md b/data/reusables/secret-scanning/partner-secret-list-public-repo.md
index 7bf2691f9b09..c294bf5f71d2 100644
--- a/data/reusables/secret-scanning/partner-secret-list-public-repo.md
+++ b/data/reusables/secret-scanning/partner-secret-list-public-repo.md
@@ -91,6 +91,7 @@ Stripe | Stripe Live API Secret Key
Stripe | Stripe Test API Secret Key
Stripe | Stripe Live API Restricted Key
Stripe | Stripe Test API Restricted Key
+Supabase | Supabase Service Key
Tencent Cloud | Tencent Cloud Secret ID
Twilio | Twilio Account String Identifier
Twilio | Twilio API Key
diff --git a/data/reusables/webhooks/check_run_properties.md b/data/reusables/webhooks/check_run_properties.md
index df177b5ef78b..b5ec1cacab4b 100644
--- a/data/reusables/webhooks/check_run_properties.md
+++ b/data/reusables/webhooks/check_run_properties.md
@@ -6,7 +6,7 @@ Key | Type | Description
`check_run[conclusion]`|`string` | The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, {% ifversion fpt or ghes or ghae or ghec %}`action_required` or `stale`{% else %}or `action_required`{% endif %}. This value will be `null` until the check run has `completed`.
`check_run[name]`|`string` | The name of the check run.
`check_run[check_suite][id]`|`integer` | The id of the check suite that this check run is part of.
-`check_run[check_suite][pull_requests]`|`array`| An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.
+`check_run[check_suite][pull_requests]`|`array`| An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_branch`.
**Note:**- The `head_sha` of the check suite can differ from the `sha` of the pull request if subsequent pushes are made into the PR.
- When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.
`check_run[check_suite][deployment]`|`object`| A deployment to a repository environment. This will only be populated if the check run was created by a {% data variables.product.prodname_actions %} workflow job that references an environment.
`requested_action`|`object` | The action requested by the user.
`requested_action[identifier]`|`string` | The integrator reference of the action requested by the user.
diff --git a/data/reusables/webhooks/check_suite_properties.md b/data/reusables/webhooks/check_suite_properties.md
index fe77bfcfd05a..07ea1debcb82 100644
--- a/data/reusables/webhooks/check_suite_properties.md
+++ b/data/reusables/webhooks/check_suite_properties.md
@@ -7,4 +7,4 @@ Key | Type | Description
`check_suite[status]`|`string` | The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.
`check_suite[conclusion]`|`string`| The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, {% ifversion fpt or ghes or ghae or ghec %}`action_required` or `stale`{% else %}or `action_required`{% endif %}. This value will be `null` until the check run has `completed`.
`check_suite[url]`|`string` | URL that points to the check suite API resource.
-`check_suite[pull_requests]`|`array`| An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.
+`check_suite[pull_requests]`|`array`| An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_branch`.
**Note:**- The `head_sha` of the check suite can differ from the `sha` of the pull request if subsequent pushes are made into the PR.
- When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.
diff --git a/data/ui.yml b/data/ui.yml
index 852e0c769e67..3d2bb36ace0b 100644
--- a/data/ui.yml
+++ b/data/ui.yml
@@ -113,7 +113,7 @@ products:
notes: Notes
parameters: Parameters
response: Response
- error_codes: Error Codes
+ status_codes: Status codes
http_status_code: HTTP Status Code
code_sample: Code sample
code_samples: Code samples
diff --git a/lib/changelog.js b/lib/changelog.js
index 36f77843956a..dc8da0082e82 100644
--- a/lib/changelog.js
+++ b/lib/changelog.js
@@ -5,6 +5,8 @@ import path from 'path'
import Parser from 'rss-parser'
const CHANGELOG_CACHE_FILE_PATH = process.env.CHANGELOG_CACHE_FILE_PATH
+// This is useful to set when doing things like sync search.
+const CHANGELOG_DISABLED = Boolean(JSON.parse(process.env.CHANGELOG_DISABLED || 'false'))
async function getRssFeed(url) {
const parser = new Parser({ timeout: 5000 })
@@ -22,6 +24,12 @@ async function getRssFeed(url) {
}
export async function getChangelogItems(prefix, feedUrl, ignoreCache = false) {
+ if (CHANGELOG_DISABLED) {
+ if (process.env.NODE_ENV === 'development') {
+ console.warn(`Downloading changelog (${feedUrl}) items is disabled.`)
+ }
+ return
+ }
if (!ignoreCache) {
const fromCache = getChangelogItemsFromCache(prefix, feedUrl)
if (fromCache) return fromCache
diff --git a/lib/rest/static/apps/enabled-for-apps.json b/lib/rest/static/apps/enabled-for-apps.json
index 08b6cf2d7927..9cadf03ef2cd 100644
--- a/lib/rest/static/apps/enabled-for-apps.json
+++ b/lib/rest/static/apps/enabled-for-apps.json
@@ -47,12 +47,12 @@
"requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}"
},
{
- "slug": "get-allowed-actions-and-workflows-for-an-organization",
+ "slug": "get-allowed-actions-and-reusable-workflows-for-an-organization",
"verb": "get",
"requestPath": "/orgs/{org}/actions/permissions/selected-actions"
},
{
- "slug": "set-allowed-actions-and-workflows-for-an-organization",
+ "slug": "set-allowed-actions-and-reusable-workflows-for-an-organization",
"verb": "put",
"requestPath": "/orgs/{org}/actions/permissions/selected-actions"
},
@@ -292,12 +292,12 @@
"requestPath": "/repos/{owner}/{repo}/actions/permissions/access"
},
{
- "slug": "get-allowed-actions-and-workflows-for-a-repository",
+ "slug": "get-allowed-actions-and-reusable-workflows-for-a-repository",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/actions/permissions/selected-actions"
},
{
- "slug": "set-allowed-actions-and-workflows-for-a-repository",
+ "slug": "set-allowed-actions-and-reusable-workflows-for-a-repository",
"verb": "put",
"requestPath": "/repos/{owner}/{repo}/actions/permissions/selected-actions"
},
diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json
index b2fcfd92b78a..8d850f41f4dc 100644
--- a/lib/rest/static/decorated/api.github.com.json
+++ b/lib/rest/static/decorated/api.github.com.json
@@ -608,7 +608,7 @@
"subcategory": "permissions",
"notes": [],
"bodyParameters": [],
- "descriptionHTML": "Gets the GitHub Actions permissions policy for organizations and allowed actions and workflows in an enterprise.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
",
+ "descriptionHTML": "Gets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
",
"responses": [
{
"httpStatusCode": "200",
@@ -667,7 +667,7 @@
},
"allowed_actions": {
"type": "string",
- "description": "The permissions policy that controls the actions and workflows that are allowed to run. Can be one of: all, local_only, or selected.
",
+ "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run. Can be one of: all, local_only, or selected.
",
"enum": [
"all",
"local_only",
@@ -676,7 +676,7 @@
"name": "allowed_actions",
"in": "body",
"rawType": "string",
- "rawDescription": "The permissions policy that controls the actions and workflows that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.",
+ "rawDescription": "The permissions policy that controls the actions and reusable workflows that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.",
"childParamsGroups": []
}
},
@@ -700,7 +700,7 @@
"category": "actions",
"subcategory": "permissions",
"notes": [],
- "descriptionHTML": "Sets the GitHub Actions permissions policy for organizations and allowed actions and workflows in an enterprise.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
",
+ "descriptionHTML": "Sets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
",
"responses": [
{
"httpStatusCode": "204",
@@ -725,7 +725,7 @@
},
{
"type": "string",
- "description": "The permissions policy that controls the actions and workflows that are allowed to run. Can be one of: all, local_only, or selected.
",
+ "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run. Can be one of: all, local_only, or selected.
",
"enum": [
"all",
"local_only",
@@ -734,7 +734,7 @@
"name": "allowed_actions",
"in": "body",
"rawType": "string",
- "rawDescription": "The permissions policy that controls the actions and workflows that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.",
+ "rawDescription": "The permissions policy that controls the actions and reusable workflows that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.",
"childParamsGroups": []
}
]
@@ -1033,18 +1033,18 @@
"source": "await octokit.request('GET /enterprises/{enterprise}/actions/permissions/selected-actions', {\n enterprise: 'enterprise'\n})"
}
],
- "summary": "Get allowed actions and workflows for an enterprise",
+ "summary": "Get allowed actions and reusable workflows for an enterprise",
"x-github": {
"enabledForGitHubApps": false,
"category": "actions",
"subcategory": "permissions"
},
- "slug": "get-allowed-actions-and-workflows-for-an-enterprise",
+ "slug": "get-allowed-actions-and-reusable-workflows-for-an-enterprise",
"category": "actions",
"subcategory": "permissions",
"notes": [],
"bodyParameters": [],
- "descriptionHTML": "Gets the selected actions and workflows that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
",
+ "descriptionHTML": "Gets the selected actions and reusable workflows that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
",
"responses": [
{
"httpStatusCode": "200",
@@ -1079,7 +1079,7 @@
"source": "await octokit.request('PUT /enterprises/{enterprise}/actions/permissions/selected-actions', {\n enterprise: 'enterprise',\n github_owned_allowed: true\n})"
}
],
- "summary": "Set allowed actions and workflows for an enterprise",
+ "summary": "Set allowed actions and reusable workflows for an enterprise",
"requestBody": {
"required": true,
"content": {
@@ -1107,14 +1107,14 @@
},
"patterns_allowed": {
"type": "array of strings",
- "description": "Specifies a list of string-matching patterns to allow specific action(s) and workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"
",
+ "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"
",
"items": {
"type": "string"
},
"name": "patterns_allowed",
"in": "body",
"rawType": "array",
- "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s) and workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
+ "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
"childParamsGroups": []
}
}
@@ -1139,11 +1139,11 @@
"category": "actions",
"subcategory": "permissions"
},
- "slug": "set-allowed-actions-and-workflows-for-an-enterprise",
+ "slug": "set-allowed-actions-and-reusable-workflows-for-an-enterprise",
"category": "actions",
"subcategory": "permissions",
"notes": [],
- "descriptionHTML": "Sets the actions and workflows that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
",
+ "descriptionHTML": "Sets the actions and reusable workflows that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
",
"responses": [
{
"httpStatusCode": "204",
@@ -1172,14 +1172,14 @@
},
{
"type": "array of strings",
- "description": "Specifies a list of string-matching patterns to allow specific action(s) and workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"
",
+ "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"
",
"items": {
"type": "string"
},
"name": "patterns_allowed",
"in": "body",
"rawType": "array",
- "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s) and workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
+ "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
"childParamsGroups": []
}
]
@@ -1219,7 +1219,7 @@
"subcategory": "permissions",
"notes": [],
"bodyParameters": [],
- "descriptionHTML": "Gets the GitHub Actions permissions policy for repositories and allowed actions and workflows in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
",
+ "descriptionHTML": "Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
",
"responses": [
{
"httpStatusCode": "200",
@@ -1277,7 +1277,7 @@
},
"allowed_actions": {
"type": "string",
- "description": "The permissions policy that controls the actions and workflows that are allowed to run. Can be one of: all, local_only, or selected.
",
+ "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run. Can be one of: all, local_only, or selected.
",
"enum": [
"all",
"local_only",
@@ -1286,7 +1286,7 @@
"name": "allowed_actions",
"in": "body",
"rawType": "string",
- "rawDescription": "The permissions policy that controls the actions and workflows that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.",
+ "rawDescription": "The permissions policy that controls the actions and reusable workflows that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.",
"childParamsGroups": []
}
},
@@ -1310,7 +1310,7 @@
"category": "actions",
"subcategory": "permissions",
"notes": [],
- "descriptionHTML": "Sets the GitHub Actions permissions policy for repositories and allowed actions and workflows in an organization.
\nIf the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as allowed_actions to selected actions and workflows, then you cannot override them for the organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
",
+ "descriptionHTML": "Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.
\nIf the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as allowed_actions to selected actions and reusable workflows, then you cannot override them for the organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
",
"responses": [
{
"httpStatusCode": "204",
@@ -1335,7 +1335,7 @@
},
{
"type": "string",
- "description": "The permissions policy that controls the actions and workflows that are allowed to run. Can be one of: all, local_only, or selected.
",
+ "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run. Can be one of: all, local_only, or selected.
",
"enum": [
"all",
"local_only",
@@ -1344,7 +1344,7 @@
"name": "allowed_actions",
"in": "body",
"rawType": "string",
- "rawDescription": "The permissions policy that controls the actions and workflows that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.",
+ "rawDescription": "The permissions policy that controls the actions and reusable workflows that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.",
"childParamsGroups": []
}
]
@@ -1636,18 +1636,18 @@
"source": "await octokit.request('GET /orgs/{org}/actions/permissions/selected-actions', {\n org: 'org'\n})"
}
],
- "summary": "Get allowed actions and workflows for an organization",
+ "summary": "Get allowed actions and reusable workflows for an organization",
"x-github": {
"enabledForGitHubApps": true,
"category": "actions",
"subcategory": "permissions"
},
- "slug": "get-allowed-actions-and-workflows-for-an-organization",
+ "slug": "get-allowed-actions-and-reusable-workflows-for-an-organization",
"category": "actions",
"subcategory": "permissions",
"notes": [],
"bodyParameters": [],
- "descriptionHTML": "Gets the selected actions and workflows that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"\"
\nYou must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
",
+ "descriptionHTML": "Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"\"
\nYou must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
",
"responses": [
{
"httpStatusCode": "200",
@@ -1681,7 +1681,7 @@
"source": "await octokit.request('PUT /orgs/{org}/actions/permissions/selected-actions', {\n org: 'org',\n github_owned_allowed: true\n})"
}
],
- "summary": "Set allowed actions and workflows for an organization",
+ "summary": "Set allowed actions and reusable workflows for an organization",
"requestBody": {
"required": false,
"content": {
@@ -1709,14 +1709,14 @@
},
"patterns_allowed": {
"type": "array of strings",
- "description": "Specifies a list of string-matching patterns to allow specific action(s) and workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"
",
+ "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"
",
"items": {
"type": "string"
},
"name": "patterns_allowed",
"in": "body",
"rawType": "array",
- "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s) and workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
+ "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
"childParamsGroups": []
}
}
@@ -1741,11 +1741,11 @@
"category": "actions",
"subcategory": "permissions"
},
- "slug": "set-allowed-actions-and-workflows-for-an-organization",
+ "slug": "set-allowed-actions-and-reusable-workflows-for-an-organization",
"category": "actions",
"subcategory": "permissions",
"notes": [],
- "descriptionHTML": "Sets the actions and workflows that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"
\nIf the organization belongs to an enterprise that has selected actions and workflows set at the enterprise level, then you cannot override any of the enterprise's allowed actions and workflows settings.
\nTo use the patterns_allowed setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories in the organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
",
+ "descriptionHTML": "Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"
\nIf the organization belongs to an enterprise that has selected actions and reusable workflows set at the enterprise level, then you cannot override any of the enterprise's allowed actions and reusable workflows settings.
\nTo use the patterns_allowed setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories in the organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
",
"responses": [
{
"httpStatusCode": "204",
@@ -1774,14 +1774,14 @@
},
{
"type": "array of strings",
- "description": "Specifies a list of string-matching patterns to allow specific action(s) and workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"
",
+ "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"
",
"items": {
"type": "string"
},
"name": "patterns_allowed",
"in": "body",
"rawType": "array",
- "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s) and workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
+ "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
"childParamsGroups": []
}
]
@@ -1984,7 +1984,7 @@
"subcategory": "permissions",
"notes": [],
"bodyParameters": [],
- "descriptionHTML": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and workflows allowed to run in the repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint. GitHub Apps must have the administration repository permission to use this API.
",
+ "descriptionHTML": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.
",
"responses": [
{
"httpStatusCode": "200",
@@ -2046,7 +2046,7 @@
},
"allowed_actions": {
"type": "string",
- "description": "The permissions policy that controls the actions and workflows that are allowed to run. Can be one of: all, local_only, or selected.
",
+ "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run. Can be one of: all, local_only, or selected.
",
"enum": [
"all",
"local_only",
@@ -2055,7 +2055,7 @@
"name": "allowed_actions",
"in": "body",
"rawType": "string",
- "rawDescription": "The permissions policy that controls the actions and workflows that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.",
+ "rawDescription": "The permissions policy that controls the actions and reusable workflows that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.",
"childParamsGroups": []
}
},
@@ -2079,7 +2079,7 @@
"category": "actions",
"subcategory": "permissions",
"notes": [],
- "descriptionHTML": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and workflows in the repository.
\nIf the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as allowed_actions to selected actions and workflows, then you cannot override them for the repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.
",
+ "descriptionHTML": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository.
\nIf the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as allowed_actions to selected actions and reusable workflows, then you cannot override them for the repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.
",
"responses": [
{
"httpStatusCode": "204",
@@ -2099,7 +2099,7 @@
},
{
"type": "string",
- "description": "The permissions policy that controls the actions and workflows that are allowed to run. Can be one of: all, local_only, or selected.
",
+ "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run. Can be one of: all, local_only, or selected.
",
"enum": [
"all",
"local_only",
@@ -2108,7 +2108,7 @@
"name": "allowed_actions",
"in": "body",
"rawType": "string",
- "rawDescription": "The permissions policy that controls the actions and workflows that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.",
+ "rawDescription": "The permissions policy that controls the actions and reusable workflows that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.",
"childParamsGroups": []
}
]
@@ -2158,7 +2158,7 @@
"subcategory": "permissions",
"notes": [],
"bodyParameters": [],
- "descriptionHTML": "Gets the level of access that workflows outside of the repository have to actions and workflows in the repository.\nThis endpoint only applies to internal repositories. For more information, see \"Managing GitHub Actions settings for a repository.\"
\nYou must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the\nrepository administration permission to use this endpoint.
",
+ "descriptionHTML": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal repositories. For more information, see \"Managing GitHub Actions settings for a repository.\"
\nYou must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the\nrepository administration permission to use this endpoint.
",
"responses": [
{
"httpStatusCode": "200",
@@ -2211,7 +2211,7 @@
"properties": {
"access_level": {
"type": "string",
- "description": "Required. Defines the level of access that workflows outside of the repository have to actions and workflows within the\nrepository. none means access is only possible from workflows in this repository. Can be one of none, organization, enterprise.
",
+ "description": "Required. Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository. none means access is only possible from workflows in this repository. Can be one of none, organization, enterprise.
",
"enum": [
"none",
"organization",
@@ -2220,7 +2220,7 @@
"name": "access_level",
"in": "body",
"rawType": "string",
- "rawDescription": "Defines the level of access that workflows outside of the repository have to actions and workflows within the\nrepository. `none` means access is only possible from workflows in this repository. Can be one of `none`, `organization`, `enterprise`.",
+ "rawDescription": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository. `none` means access is only possible from workflows in this repository. Can be one of `none`, `organization`, `enterprise`.",
"childParamsGroups": []
}
},
@@ -2248,7 +2248,7 @@
"category": "actions",
"subcategory": "permissions",
"notes": [],
- "descriptionHTML": "Sets the level of access that workflows outside of the repository have to actions and workflows in the repository.\nThis endpoint only applies to internal repositories. For more information, see \"Managing GitHub Actions settings for a repository.\"
\nYou must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the\nrepository administration permission to use this endpoint.
",
+ "descriptionHTML": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal repositories. For more information, see \"Managing GitHub Actions settings for a repository.\"
\nYou must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the\nrepository administration permission to use this endpoint.
",
"responses": [
{
"httpStatusCode": "204",
@@ -2259,7 +2259,7 @@
"bodyParameters": [
{
"type": "string",
- "description": "Required. Defines the level of access that workflows outside of the repository have to actions and workflows within the\nrepository. none means access is only possible from workflows in this repository. Can be one of none, organization, enterprise.
",
+ "description": "Required. Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository. none means access is only possible from workflows in this repository. Can be one of none, organization, enterprise.
",
"enum": [
"none",
"organization",
@@ -2268,7 +2268,7 @@
"name": "access_level",
"in": "body",
"rawType": "string",
- "rawDescription": "Defines the level of access that workflows outside of the repository have to actions and workflows within the\nrepository. `none` means access is only possible from workflows in this repository. Can be one of `none`, `organization`, `enterprise`.",
+ "rawDescription": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository. `none` means access is only possible from workflows in this repository. Can be one of `none`, `organization`, `enterprise`.",
"childParamsGroups": []
}
]
@@ -2306,18 +2306,18 @@
"source": "await octokit.request('GET /repos/{owner}/{repo}/actions/permissions/selected-actions', {\n owner: 'octocat',\n repo: 'hello-world'\n})"
}
],
- "summary": "Get allowed actions and workflows for a repository",
+ "summary": "Get allowed actions and reusable workflows for a repository",
"x-github": {
"enabledForGitHubApps": true,
"category": "actions",
"subcategory": "permissions"
},
- "slug": "get-allowed-actions-and-workflows-for-a-repository",
+ "slug": "get-allowed-actions-and-reusable-workflows-for-a-repository",
"category": "actions",
"subcategory": "permissions",
"notes": [],
"bodyParameters": [],
- "descriptionHTML": "Gets the settings for selected actions and workflows that are allowed in a repository. To use this endpoint, the repository policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for a repository.\"
\nYou must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.
",
+ "descriptionHTML": "Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for a repository.\"
\nYou must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.
",
"responses": [
{
"httpStatusCode": "200",
@@ -2360,7 +2360,7 @@
"source": "await octokit.request('PUT /repos/{owner}/{repo}/actions/permissions/selected-actions', {\n owner: 'octocat',\n repo: 'hello-world',\n github_owned_allowed: true\n})"
}
],
- "summary": "Set allowed actions and workflows for a repository",
+ "summary": "Set allowed actions and reusable workflows for a repository",
"requestBody": {
"required": false,
"content": {
@@ -2388,14 +2388,14 @@
},
"patterns_allowed": {
"type": "array of strings",
- "description": "Specifies a list of string-matching patterns to allow specific action(s) and workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"
",
+ "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"
",
"items": {
"type": "string"
},
"name": "patterns_allowed",
"in": "body",
"rawType": "array",
- "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s) and workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
+ "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
"childParamsGroups": []
}
}
@@ -2420,11 +2420,11 @@
"category": "actions",
"subcategory": "permissions"
},
- "slug": "set-allowed-actions-and-workflows-for-a-repository",
+ "slug": "set-allowed-actions-and-reusable-workflows-for-a-repository",
"category": "actions",
"subcategory": "permissions",
"notes": [],
- "descriptionHTML": "Sets the actions and workflows that are allowed in a repository. To use this endpoint, the repository permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for a repository.\"
\nIf the repository belongs to an organization or enterprise that has selected actions and workflows set at the organization or enterprise levels, then you cannot override any of the allowed actions and workflows settings.
\nTo use the patterns_allowed setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories.
\nYou must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.
",
+ "descriptionHTML": "Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for a repository.\"
\nIf the repository belongs to an organization or enterprise that has selected actions and reusable workflows set at the organization or enterprise levels, then you cannot override any of the allowed actions and reusable workflows settings.
\nTo use the patterns_allowed setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories.
\nYou must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.
",
"responses": [
{
"httpStatusCode": "204",
@@ -2453,14 +2453,14 @@
},
{
"type": "array of strings",
- "description": "Specifies a list of string-matching patterns to allow specific action(s) and workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"
",
+ "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"
",
"items": {
"type": "string"
},
"name": "patterns_allowed",
"in": "body",
"rawType": "array",
- "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s) and workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
+ "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
"childParamsGroups": []
}
]
@@ -4099,17 +4099,21 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected",
- "selected_organization_ids": [
- 32,
- 91
- ],
- "runners": [
- 9,
- 2
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected",
+ "selected_organization_ids": [
+ 32,
+ 91
+ ],
+ "runners": [
+ 9,
+ 2
+ ]
+ }
+ }
}
}
}
@@ -4327,9 +4331,13 @@
}
}
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected"
+ }
+ }
}
}
}
@@ -5223,17 +5231,21 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected",
- "selected_repository_ids": [
- 32,
- 91
- ],
- "runners": [
- 9,
- 2
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected",
+ "selected_repository_ids": [
+ 32,
+ 91
+ ],
+ "runners": [
+ 9,
+ 2
+ ]
+ }
+ }
}
}
}
@@ -5454,9 +5466,13 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected"
+ }
+ }
}
}
}
@@ -19745,8 +19761,12 @@
"new_name"
]
},
- "example": {
- "new_name": "my_renamed_branch"
+ "examples": {
+ "default": {
+ "value": {
+ "new_name": "my_renamed_branch"
+ }
+ }
}
}
}
@@ -19851,8 +19871,12 @@
"branch"
]
},
- "example": {
- "branch": "main"
+ "examples": {
+ "default": {
+ "value": {
+ "branch": "main"
+ }
+ }
}
}
}
@@ -21227,26 +21251,30 @@
}
}
},
- "example": {
- "dismissal_restrictions": {
- "users": [
- "octocat"
- ],
- "teams": [
- "justice-league"
- ]
- },
- "bypass_pull_request_allowances": {
- "users": [
- "octocat"
- ],
- "teams": [
- "justice-league"
- ]
- },
- "dismiss_stale_reviews": true,
- "require_code_owner_reviews": true,
- "required_approving_review_count": 2
+ "examples": {
+ "default": {
+ "value": {
+ "dismissal_restrictions": {
+ "users": [
+ "octocat"
+ ],
+ "teams": [
+ "justice-league"
+ ]
+ },
+ "bypass_pull_request_allowances": {
+ "users": [
+ "octocat"
+ ],
+ "teams": [
+ "justice-league"
+ ]
+ },
+ "dismiss_stale_reviews": true,
+ "require_code_owner_reviews": true,
+ "required_approving_review_count": 2
+ }
+ }
}
}
}
@@ -21923,11 +21951,15 @@
}
}
},
- "example": {
- "strict": true,
- "contexts": [
- "continuous-integration/travis-ci"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "strict": true,
+ "contexts": [
+ "continuous-integration/travis-ci"
+ ]
+ }
+ }
}
}
}
@@ -28845,13 +28877,17 @@
}
}
},
- "example": {
- "auto_trigger_checks": [
- {
- "app_id": 4,
- "setting": false
+ "examples": {
+ "default": {
+ "value": {
+ "auto_trigger_checks": [
+ {
+ "app_id": 4,
+ "setting": false
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -29678,9 +29714,13 @@
"state"
]
},
- "example": {
- "state": "dismissed",
- "dismissed_reason": "false positive"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "dismissed",
+ "dismissed_reason": "false positive"
+ }
+ }
}
}
}
@@ -31733,8 +31773,12 @@
}
}
},
- "example": {
- "machine": "standardLinux"
+ "examples": {
+ "default": {
+ "value": {
+ "machine": "standardLinux"
+ }
+ }
}
}
}
@@ -34585,8 +34629,12 @@
"body"
]
},
- "example": {
- "body": "Nice change"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Nice change"
+ }
+ }
}
}
}
@@ -34872,11 +34920,15 @@
"body"
]
},
- "example": {
- "body": "Great stuff",
- "path": "file1.txt",
- "position": 4,
- "line": 1
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Great stuff",
+ "path": "file1.txt",
+ "position": 4,
+ "line": 1
+ }
+ }
}
}
}
@@ -35230,11 +35282,15 @@
"state"
]
},
- "example": {
- "state": "success",
- "target_url": "https://example.com/build/status",
- "description": "The build succeeded!",
- "context": "continuous-integration/jenkins"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "success",
+ "target_url": "https://example.com/build/status",
+ "description": "The build succeeded!",
+ "context": "continuous-integration/jenkins"
+ }
+ }
}
}
}
@@ -36539,10 +36595,14 @@
"key"
]
},
- "example": {
- "title": "octocat@octomac",
- "key": "ssh-rsa AAA...",
- "read_only": true
+ "examples": {
+ "default": {
+ "value": {
+ "title": "octocat@octomac",
+ "key": "ssh-rsa AAA...",
+ "read_only": true
+ }
+ }
}
}
}
@@ -37951,11 +38011,15 @@
"state"
]
},
- "example": {
- "environment": "production",
- "state": "success",
- "log_url": "https://example.com/deployment/42/output",
- "description": "Deployment finished successfully."
+ "examples": {
+ "default": {
+ "value": {
+ "environment": "production",
+ "state": "success",
+ "log_url": "https://example.com/deployment/42/output",
+ "description": "Deployment finished successfully."
+ }
+ }
}
}
}
@@ -38718,19 +38782,23 @@
"displayName"
]
},
- "example": {
- "schemas": [
- "urn:ietf:params:scim:schemas:core:2.0:Group"
- ],
- "displayName": "octo-org",
- "members": [
- {
- "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc"
- },
- {
- "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5"
+ "examples": {
+ "default": {
+ "value": {
+ "schemas": [
+ "urn:ietf:params:scim:schemas:core:2.0:Group"
+ ],
+ "displayName": "octo-org",
+ "members": [
+ {
+ "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc"
+ },
+ {
+ "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5"
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -38997,19 +39065,23 @@
"displayName"
]
},
- "example": {
- "schemas": [
- "urn:ietf:params:scim:schemas:core:2.0:Group"
- ],
- "displayName": "octo-org",
- "members": [
- {
- "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc"
- },
- {
- "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5"
+ "examples": {
+ "default": {
+ "value": {
+ "schemas": [
+ "urn:ietf:params:scim:schemas:core:2.0:Group"
+ ],
+ "displayName": "octo-org",
+ "members": [
+ {
+ "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc"
+ },
+ {
+ "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5"
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -39249,21 +39321,25 @@
"Operations"
]
},
- "example": {
- "schemas": [
- "urn:ietf:params:scim:api:messages:2.0:PatchOp"
- ],
- "Operations": [
- {
- "op": "remove",
- "path": "members",
- "value": [
+ "examples": {
+ "default": {
+ "value": {
+ "schemas": [
+ "urn:ietf:params:scim:api:messages:2.0:PatchOp"
+ ],
+ "Operations": [
{
- "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5"
+ "op": "remove",
+ "path": "members",
+ "value": [
+ {
+ "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5"
+ }
+ ]
}
]
}
- ]
+ }
}
}
}
@@ -39761,27 +39837,31 @@
"emails"
]
},
- "example": {
- "schemas": [
- "urn:ietf:params:scim:schemas:core:2.0:User"
- ],
- "userName": "mona.octocat@okta.example.com",
- "name": {
- "familyName": "Octocat",
- "givenName": "Mona"
- },
- "emails": [
- {
- "value": "mona.octocat@okta.example.com",
- "type": "work",
- "primary": true
- }
- ],
- "groups": [
- {
- "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d"
+ "examples": {
+ "default": {
+ "value": {
+ "schemas": [
+ "urn:ietf:params:scim:schemas:core:2.0:User"
+ ],
+ "userName": "mona.octocat@okta.example.com",
+ "name": {
+ "familyName": "Octocat",
+ "givenName": "Mona"
+ },
+ "emails": [
+ {
+ "value": "mona.octocat@okta.example.com",
+ "type": "work",
+ "primary": true
+ }
+ ],
+ "groups": [
+ {
+ "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d"
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -40310,27 +40390,31 @@
"emails"
]
},
- "example": {
- "schemas": [
- "urn:ietf:params:scim:schemas:core:2.0:User"
- ],
- "userName": "mona.octocat@okta.example.com",
- "name": {
- "familyName": "Octocat",
- "givenName": "Mona"
- },
- "emails": [
- {
- "value": "mona.octocat@okta.example.com",
- "type": "work",
- "primary": true
- }
- ],
- "groups": [
- {
- "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d"
+ "examples": {
+ "default": {
+ "value": {
+ "schemas": [
+ "urn:ietf:params:scim:schemas:core:2.0:User"
+ ],
+ "userName": "mona.octocat@okta.example.com",
+ "name": {
+ "familyName": "Octocat",
+ "givenName": "Mona"
+ },
+ "emails": [
+ {
+ "value": "mona.octocat@okta.example.com",
+ "type": "work",
+ "primary": true
+ }
+ ],
+ "groups": [
+ {
+ "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d"
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -40627,27 +40711,31 @@
"Operations"
]
},
- "example": {
- "schemas": [
- "urn:ietf:params:scim:api:messages:2.0:PatchOp"
- ],
- "Operations": [
- {
- "op": "add",
- "path": "emails",
- "value": [
+ "examples": {
+ "default": {
+ "value": {
+ "schemas": [
+ "urn:ietf:params:scim:api:messages:2.0:PatchOp"
+ ],
+ "Operations": [
+ {
+ "op": "add",
+ "path": "emails",
+ "value": [
+ {
+ "value": "monalisa@octocat.github.com",
+ "type": "home"
+ }
+ ]
+ },
{
- "value": "monalisa@octocat.github.com",
- "type": "home"
+ "op": "replace",
+ "path": "name.givenName",
+ "value": "Monalisa"
}
]
- },
- {
- "op": "replace",
- "path": "name.givenName",
- "value": "Monalisa"
}
- ]
+ }
}
}
}
@@ -42597,9 +42685,13 @@
"content"
]
},
- "example": {
- "content": "Content of the blob",
- "encoding": "utf-8"
+ "examples": {
+ "default": {
+ "value": {
+ "content": "Content of the blob",
+ "encoding": "utf-8"
+ }
+ }
}
}
}
@@ -43527,9 +43619,13 @@
"sha"
]
},
- "example": {
- "ref": "refs/heads/featureA",
- "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd"
+ "examples": {
+ "default": {
+ "value": {
+ "ref": "refs/heads/featureA",
+ "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd"
+ }
+ }
}
}
}
@@ -43665,9 +43761,13 @@
"sha"
]
},
- "example": {
- "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
- "force": true
+ "examples": {
+ "default": {
+ "value": {
+ "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
+ "force": true
+ }
+ }
}
}
}
@@ -43957,15 +44057,19 @@
"type"
]
},
- "example": {
- "tag": "v0.0.1",
- "message": "initial version",
- "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
- "type": "commit",
- "tagger": {
- "name": "Monalisa Octocat",
- "email": "octocat@github.com",
- "date": "2011-06-17T14:53:35-07:00"
+ "examples": {
+ "default": {
+ "value": {
+ "tag": "v0.0.1",
+ "message": "initial version",
+ "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
+ "type": "commit",
+ "tagger": {
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com",
+ "date": "2011-06-17T14:53:35-07:00"
+ }
+ }
}
}
}
@@ -44384,16 +44488,20 @@
"tree"
]
},
- "example": {
- "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
- "tree": [
- {
- "path": "file.rb",
- "mode": "100644",
- "type": "blob",
- "sha": "44b4fc6d56897b048c772eb4087f854f46256132"
+ "examples": {
+ "default": {
+ "value": {
+ "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
+ "tree": [
+ {
+ "path": "file.rb",
+ "mode": "100644",
+ "type": "blob",
+ "sha": "44b4fc6d56897b048c772eb4087f854f46256132"
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -46178,16 +46286,20 @@
"title"
]
},
- "example": {
- "title": "Found a bug",
- "body": "I'm having a problem with this.",
- "assignees": [
- "octocat"
- ],
- "milestone": 1,
- "labels": [
- "bug"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Found a bug",
+ "body": "I'm having a problem with this.",
+ "assignees": [
+ "octocat"
+ ],
+ "milestone": 1,
+ "labels": [
+ "bug"
+ ]
+ }
+ }
}
}
}
@@ -47379,11 +47491,15 @@
}
}
},
- "example": {
- "assignees": [
- "hubot",
- "other_user"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "assignees": [
+ "hubot",
+ "other_user"
+ ]
+ }
+ }
}
}
}
@@ -47485,11 +47601,15 @@
}
}
},
- "example": {
- "assignees": [
- "hubot",
- "other_user"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "assignees": [
+ "hubot",
+ "other_user"
+ ]
+ }
+ }
}
}
}
@@ -47787,8 +47907,12 @@
"body"
]
},
- "example": {
- "body": "Me too"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Me too"
+ }
+ }
}
}
}
@@ -48061,8 +48185,12 @@
"body"
]
},
- "example": {
- "body": "Me too"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Me too"
+ }
+ }
}
}
}
@@ -48572,11 +48700,15 @@
}
]
},
- "example": {
- "labels": [
- "bug",
- "enhancement"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "labels": [
+ "bug",
+ "enhancement"
+ ]
+ }
+ }
}
}
}
@@ -48740,11 +48872,15 @@
}
]
},
- "example": {
- "labels": [
- "bug",
- "enhancement"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "labels": [
+ "bug",
+ "enhancement"
+ ]
+ }
+ }
}
}
}
@@ -49096,10 +49232,14 @@
"name"
]
},
- "example": {
- "name": "bug",
- "description": "Something isn't working",
- "color": "f29513"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513"
+ }
+ }
}
}
}
@@ -49309,10 +49449,14 @@
}
}
},
- "example": {
- "new_name": "bug :bug:",
- "description": "Small bug fix required",
- "color": "b01f26"
+ "examples": {
+ "default": {
+ "value": {
+ "new_name": "bug :bug:",
+ "description": "Small bug fix required",
+ "color": "b01f26"
+ }
+ }
}
}
}
@@ -49726,11 +49870,15 @@
"title"
]
},
- "example": {
- "title": "v1.0",
- "state": "open",
- "description": "Tracking milestone for version 1.0",
- "due_on": "2012-10-09T23:39:01Z"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "v1.0",
+ "state": "open",
+ "description": "Tracking milestone for version 1.0",
+ "due_on": "2012-10-09T23:39:01Z"
+ }
+ }
}
}
}
@@ -49972,11 +50120,15 @@
}
}
},
- "example": {
- "title": "v1.0",
- "state": "open",
- "description": "Tracking milestone for version 1.0",
- "due_on": "2012-10-09T23:39:01Z"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "v1.0",
+ "state": "open",
+ "description": "Tracking milestone for version 1.0",
+ "due_on": "2012-10-09T23:39:01Z"
+ }
+ }
}
}
}
@@ -51575,11 +51727,15 @@
"repositories"
]
},
- "example": {
- "repositories": [
- "github/Hello-World"
- ],
- "lock_repositories": true
+ "examples": {
+ "default": {
+ "value": {
+ "repositories": [
+ "github/Hello-World"
+ ],
+ "lock_repositories": true
+ }
+ }
}
}
}
@@ -52197,11 +52353,15 @@
"vcs_url"
]
},
- "example": {
- "vcs": "subversion",
- "vcs_url": "http://svn.mycompany.com/svn/myproject",
- "vcs_username": "octocat",
- "vcs_password": "secret"
+ "examples": {
+ "default": {
+ "value": {
+ "vcs": "subversion",
+ "vcs_url": "http://svn.mycompany.com/svn/myproject",
+ "vcs_username": "octocat",
+ "vcs_password": "secret"
+ }
+ }
}
}
}
@@ -52679,9 +52839,13 @@
},
"additionalProperties": false
},
- "example": {
- "email": "hubot@github.com",
- "name": "Hubot the Robot"
+ "examples": {
+ "default": {
+ "value": {
+ "email": "hubot@github.com",
+ "name": "Hubot the Robot"
+ }
+ }
}
}
}
@@ -52848,8 +53012,12 @@
"use_lfs"
]
},
- "example": {
- "use_lfs": "opt_in"
+ "examples": {
+ "default": {
+ "value": {
+ "use_lfs": "opt_in"
+ }
+ }
}
}
}
@@ -55173,17 +55341,21 @@
}
}
},
- "example": {
- "billing_email": "mona@github.com",
- "company": "GitHub",
- "email": "mona@github.com",
- "twitter_username": "github",
- "location": "San Francisco",
- "name": "github",
- "description": "GitHub, the company.",
- "default_repository_permission": "read",
- "members_can_create_repositories": true,
- "members_allowed_repository_creation_type": "all"
+ "examples": {
+ "default": {
+ "value": {
+ "billing_email": "mona@github.com",
+ "company": "GitHub",
+ "email": "mona@github.com",
+ "twitter_username": "github",
+ "location": "San Francisco",
+ "name": "github",
+ "description": "GitHub, the company.",
+ "default_repository_permission": "read",
+ "members_can_create_repositories": true,
+ "members_allowed_repository_creation_type": "all"
+ }
+ }
}
}
}
@@ -56353,13 +56525,17 @@
}
}
},
- "example": {
- "email": "octocat@github.com",
- "role": "direct_member",
- "team_ids": [
- 12,
- 26
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "email": "octocat@github.com",
+ "role": "direct_member",
+ "team_ids": [
+ 12,
+ 26
+ ]
+ }
+ }
}
}
}
@@ -57473,8 +57649,12 @@
"state"
]
},
- "example": {
- "state": "active"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "active"
+ }
+ }
}
}
}
@@ -58058,16 +58238,20 @@
"config"
]
},
- "example": {
- "name": "web",
- "active": true,
- "events": [
- "push",
- "pull_request"
- ],
- "config": {
- "url": "http://example.com/webhook",
- "content_type": "json"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "url": "http://example.com/webhook",
+ "content_type": "json"
+ }
+ }
}
}
}
@@ -58588,11 +58772,15 @@
}
}
},
- "example": {
- "active": true,
- "events": [
- "pull_request"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "active": true,
+ "events": [
+ "pull_request"
+ ]
+ }
+ }
}
}
}
@@ -62566,9 +62754,13 @@
"name"
]
},
- "example": {
- "name": "Organization Roadmap",
- "body": "High-level roadmap for the upcoming year."
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Organization Roadmap",
+ "body": "High-level roadmap for the upcoming year."
+ }
+ }
}
}
}
@@ -63159,9 +63351,13 @@
"name"
]
},
- "example": {
- "name": "Projects Documentation",
- "body": "Developer documentation project for the developer site."
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Projects Documentation",
+ "body": "Developer documentation project for the developer site."
+ }
+ }
}
}
}
@@ -65335,11 +65531,15 @@
"base"
]
},
- "example": {
- "title": "Amazing new feature",
- "body": "Please pull these awesome changes in!",
- "head": "octocat:new-feature",
- "base": "master"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Amazing new feature",
+ "body": "Please pull these awesome changes in!",
+ "head": "octocat:new-feature",
+ "base": "master"
+ }
+ }
}
}
}
@@ -65620,11 +65820,15 @@
}
}
},
- "example": {
- "title": "new title",
- "body": "updated body",
- "state": "open",
- "base": "master"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "new title",
+ "body": "updated body",
+ "state": "open",
+ "base": "master"
+ }
+ }
}
}
}
@@ -66500,8 +66704,12 @@
"body"
]
},
- "example": {
- "body": "I like this too!"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "I like this too!"
+ }
+ }
}
}
}
@@ -67091,8 +67299,12 @@
"body"
]
},
- "example": {
- "body": "Great stuff!"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Great stuff!"
+ }
+ }
}
}
}
@@ -67306,15 +67518,19 @@
}
]
},
- "example": {
- "reviewers": [
- "octocat",
- "hubot",
- "other_user"
- ],
- "team_reviewers": [
- "justice-league"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "reviewers": [
+ "octocat",
+ "hubot",
+ "other_user"
+ ],
+ "team_reviewers": [
+ "justice-league"
+ ]
+ }
+ }
}
}
}
@@ -67853,17 +68069,21 @@
}
}
},
- "example": {
- "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
- "body": "This is close to perfect! Please address the suggested inline change.",
- "event": "REQUEST_CHANGES",
- "comments": [
- {
- "path": "file.md",
- "position": 6,
- "body": "Please add more information here, and fix this typo."
+ "examples": {
+ "default": {
+ "value": {
+ "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
+ "body": "This is close to perfect! Please address the suggested inline change.",
+ "event": "REQUEST_CHANGES",
+ "comments": [
+ {
+ "path": "file.md",
+ "position": 6,
+ "body": "Please add more information here, and fix this typo."
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -69641,7 +69861,7 @@
"content"
]
},
- "example": {
+ "examples": {
"default": {
"value": {
"content": "heart"
@@ -71231,8 +71451,12 @@
"content"
]
},
- "example": {
- "content": "heart"
+ "examples": {
+ "default": {
+ "value": {
+ "content": "heart"
+ }
+ }
}
}
}
@@ -71442,8 +71666,12 @@
"content"
]
},
- "example": {
- "content": "heart"
+ "examples": {
+ "default": {
+ "value": {
+ "content": "heart"
+ }
+ }
}
}
}
@@ -71695,14 +71923,18 @@
"tag_name"
]
},
- "example": {
- "tag_name": "v1.0.0",
- "target_commitish": "master",
- "name": "v1.0.0",
- "body": "Description of the release",
- "draft": false,
- "prerelease": false,
- "generate_release_notes": false
+ "examples": {
+ "default": {
+ "value": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "master",
+ "name": "v1.0.0",
+ "body": "Description of the release",
+ "draft": false,
+ "prerelease": false,
+ "generate_release_notes": false
+ }
+ }
}
}
}
@@ -71896,11 +72128,15 @@
"tag_name"
]
},
- "example": {
- "tag_name": "v1.0.0",
- "target_commitish": "main",
- "previous_tag_name": "v0.9.2",
- "configuration_file_path": ".github/custom_release_config.yml"
+ "examples": {
+ "default": {
+ "value": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "main",
+ "previous_tag_name": "v0.9.2",
+ "configuration_file_path": ".github/custom_release_config.yml"
+ }
+ }
}
}
}
@@ -72276,13 +72512,17 @@
}
}
},
- "example": {
- "tag_name": "v1.0.0",
- "target_commitish": "master",
- "name": "v1.0.0",
- "body": "Description of the release",
- "draft": false,
- "prerelease": false
+ "examples": {
+ "default": {
+ "value": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "master",
+ "name": "v1.0.0",
+ "body": "Description of the release",
+ "draft": false,
+ "prerelease": false
+ }
+ }
}
}
}
@@ -72602,9 +72842,13 @@
}
}
},
- "example": {
- "name": "foo-1.0.0-osx.zip",
- "label": "Mac binary"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "foo-1.0.0-osx.zip",
+ "label": "Mac binary"
+ }
+ }
}
}
}
@@ -73248,14 +73492,18 @@
"name"
]
},
- "example": {
- "name": "Hello-World",
- "description": "This is your first repository",
- "homepage": "https://github.com",
- "private": false,
- "has_issues": true,
- "has_projects": true,
- "has_wiki": true
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Hello-World",
+ "description": "This is your first repository",
+ "homepage": "https://github.com",
+ "private": false,
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true
+ }
+ }
}
}
}
@@ -74870,13 +75118,17 @@
"names"
]
},
- "example": {
- "names": [
- "octocat",
- "atom",
- "electron",
- "api"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "names": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ]
+ }
+ }
}
}
}
@@ -74991,12 +75243,16 @@
"new_owner"
]
},
- "example": {
- "new_owner": "github",
- "team_ids": [
- 12,
- 345
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "new_owner": "github",
+ "team_ids": [
+ 12,
+ 345
+ ]
+ }
+ }
}
}
}
@@ -75300,12 +75556,16 @@
"name"
]
},
- "example": {
- "owner": "octocat",
- "name": "Hello-World",
- "description": "This is your first repository",
- "include_all_branches": false,
- "private": false
+ "examples": {
+ "default": {
+ "value": {
+ "owner": "octocat",
+ "name": "Hello-World",
+ "description": "This is your first repository",
+ "include_all_branches": false,
+ "private": false
+ }
+ }
}
}
}
@@ -76358,9 +76618,13 @@
"url_template"
]
},
- "example": {
- "key_prefix": "TICKET-",
- "url_template": "https://example.com/TICKET?query="
+ "examples": {
+ "default": {
+ "value": {
+ "key_prefix": "TICKET-",
+ "url_template": "https://example.com/TICKET?query="
+ }
+ }
}
}
}
@@ -77375,13 +77639,17 @@
"sha"
]
},
- "example": {
- "message": "my commit message",
- "committer": {
- "name": "Monalisa Octocat",
- "email": "octocat@github.com"
- },
- "sha": "329688480d39049927147c162b9d2deaf885005f"
+ "examples": {
+ "default": {
+ "value": {
+ "message": "my commit message",
+ "committer": {
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com"
+ },
+ "sha": "329688480d39049927147c162b9d2deaf885005f"
+ }
+ }
}
}
}
@@ -78260,6 +78528,11 @@
"httpStatusCode": "404",
"httpStatusMessage": "Not Found",
"description": "Resource not found
"
+ },
+ {
+ "httpStatusCode": "429",
+ "httpStatusMessage": "Too Many Requests",
+ "description": "Too Many Requests
"
}
],
"subcategory": "scim"
@@ -81257,9 +81530,13 @@
"state"
]
},
- "example": {
- "state": "resolved",
- "resolution": "false_positive"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "resolved",
+ "resolution": "false_positive"
+ }
+ }
}
}
}
@@ -81616,11 +81893,15 @@
"name"
]
},
- "example": {
- "name": "Justice League",
- "description": "A great team",
- "permission": "push",
- "privacy": "closed"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Justice League",
+ "description": "A great team",
+ "permission": "push",
+ "privacy": "closed"
+ }
+ }
}
}
}
@@ -81896,10 +82177,14 @@
}
}
},
- "example": {
- "name": "new team name",
- "description": "new team description",
- "privacy": "closed"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "new team name",
+ "description": "new team description",
+ "privacy": "closed"
+ }
+ }
}
}
}
@@ -84070,8 +84355,12 @@
"body"
]
},
- "example": {
- "body": "Do you like apples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like apples?"
+ }
+ }
}
}
}
@@ -84254,8 +84543,12 @@
"body"
]
},
- "example": {
- "body": "Do you like pineapples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like pineapples?"
+ }
+ }
}
}
}
@@ -84509,8 +84802,12 @@
"body"
]
},
- "example": {
- "body": "Do you like apples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like apples?"
+ }
+ }
}
}
}
@@ -84679,8 +84976,12 @@
"body"
]
},
- "example": {
- "body": "Do you like pineapples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like pineapples?"
+ }
+ }
}
}
}
@@ -84961,9 +85262,13 @@
"body"
]
},
- "example": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Our first team post",
+ "body": "Hi! This is an area for us to collaborate as a team."
+ }
+ }
}
}
}
@@ -85153,8 +85458,12 @@
}
}
},
- "example": {
- "title": "Welcome to our first team post"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Welcome to our first team post"
+ }
+ }
}
}
}
@@ -85410,9 +85719,13 @@
"body"
]
},
- "example": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Our first team post",
+ "body": "Hi! This is an area for us to collaborate as a team."
+ }
+ }
}
}
}
@@ -85588,8 +85901,12 @@
}
}
},
- "example": {
- "title": "Welcome to our first team post"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Welcome to our first team post"
+ }
+ }
}
}
}
@@ -85936,8 +86253,12 @@
"group_id"
]
},
- "example": {
- "group_id": 123
+ "examples": {
+ "default": {
+ "value": {
+ "group_id": 123
+ }
+ }
}
}
}
@@ -87282,14 +87603,18 @@
},
"additionalProperties": false
},
- "example": {
- "groups": [
- {
- "group_id": "123",
- "group_name": "Octocat admins",
- "group_description": "string"
+ "examples": {
+ "default": {
+ "value": {
+ "groups": [
+ {
+ "group_id": "123",
+ "group_name": "Octocat admins",
+ "group_description": "string"
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -87649,15 +87974,19 @@
"groups"
]
},
- "example": {
- "groups": [
- {
- "group_id": "123",
- "group_name": "Octocat admins",
- "description": "The people who configure your octoworld.",
- "group_description": "string"
+ "examples": {
+ "default": {
+ "value": {
+ "groups": [
+ {
+ "group_id": "123",
+ "group_name": "Octocat admins",
+ "description": "The people who configure your octoworld.",
+ "group_description": "string"
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -91297,17 +91626,21 @@
},
"additionalProperties": false
},
- "example": {
- "name": "web",
- "active": true,
- "events": [
- "push",
- "pull_request"
- ],
- "config": {
- "url": "https://example.com/webhook",
- "content_type": "json",
- "insecure_ssl": "0"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "url": "https://example.com/webhook",
+ "content_type": "json",
+ "insecure_ssl": "0"
+ }
+ }
}
}
}
@@ -91905,11 +92238,15 @@
}
}
},
- "example": {
- "active": true,
- "add_events": [
- "pull_request"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "active": true,
+ "add_events": [
+ "pull_request"
+ ]
+ }
+ }
}
}
}
diff --git a/lib/rest/static/decorated/ghes-3.1.json b/lib/rest/static/decorated/ghes-3.1.json
index 0088ed8c03c5..b458af649361 100644
--- a/lib/rest/static/decorated/ghes-3.1.json
+++ b/lib/rest/static/decorated/ghes-3.1.json
@@ -1590,7 +1590,7 @@
"subcategory": "permissions",
"notes": [],
"bodyParameters": [],
- "descriptionHTML": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint. GitHub Apps must have the administration repository permission to use this API.
",
+ "descriptionHTML": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.
",
"responses": [
{
"httpStatusCode": "200",
@@ -3144,17 +3144,21 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected",
- "selected_organization_ids": [
- 32,
- 91
- ],
- "runners": [
- 9,
- 2
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected",
+ "selected_organization_ids": [
+ 32,
+ 91
+ ],
+ "runners": [
+ 9,
+ 2
+ ]
+ }
+ }
}
}
}
@@ -3372,9 +3376,13 @@
}
}
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected"
+ }
+ }
}
}
}
@@ -4268,17 +4276,21 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected",
- "selected_repository_ids": [
- 32,
- 91
- ],
- "runners": [
- 9,
- 2
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected",
+ "selected_repository_ids": [
+ 32,
+ 91
+ ],
+ "runners": [
+ 9,
+ 2
+ ]
+ }
+ }
}
}
}
@@ -4499,9 +4511,13 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected"
+ }
+ }
}
}
}
@@ -15977,8 +15993,12 @@
"new_name"
]
},
- "example": {
- "new_name": "my_renamed_branch"
+ "examples": {
+ "default": {
+ "value": {
+ "new_name": "my_renamed_branch"
+ }
+ }
}
}
}
@@ -17293,26 +17313,30 @@
}
}
},
- "example": {
- "dismissal_restrictions": {
- "users": [
- "octocat"
- ],
- "teams": [
- "justice-league"
- ]
- },
- "bypass_pull_request_allowances": {
- "users": [
- "octocat"
- ],
- "teams": [
- "justice-league"
- ]
- },
- "dismiss_stale_reviews": true,
- "require_code_owner_reviews": true,
- "required_approving_review_count": 2
+ "examples": {
+ "default": {
+ "value": {
+ "dismissal_restrictions": {
+ "users": [
+ "octocat"
+ ],
+ "teams": [
+ "justice-league"
+ ]
+ },
+ "bypass_pull_request_allowances": {
+ "users": [
+ "octocat"
+ ],
+ "teams": [
+ "justice-league"
+ ]
+ },
+ "dismiss_stale_reviews": true,
+ "require_code_owner_reviews": true,
+ "required_approving_review_count": 2
+ }
+ }
}
}
}
@@ -17885,11 +17909,15 @@
}
}
},
- "example": {
- "strict": true,
- "contexts": [
- "continuous-integration/travis-ci"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "strict": true,
+ "contexts": [
+ "continuous-integration/travis-ci"
+ ]
+ }
+ }
}
}
}
@@ -24668,13 +24696,17 @@
}
}
},
- "example": {
- "auto_trigger_checks": [
- {
- "app_id": 4,
- "setting": false
+ "examples": {
+ "default": {
+ "value": {
+ "auto_trigger_checks": [
+ {
+ "app_id": 4,
+ "setting": false
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -25313,9 +25345,13 @@
"state"
]
},
- "example": {
- "state": "dismissed",
- "dismissed_reason": "false positive"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "dismissed",
+ "dismissed_reason": "false positive"
+ }
+ }
}
}
}
@@ -27818,8 +27854,12 @@
"body"
]
},
- "example": {
- "body": "Nice change"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Nice change"
+ }
+ }
}
}
}
@@ -28111,11 +28151,15 @@
"body"
]
},
- "example": {
- "body": "Great stuff",
- "path": "file1.txt",
- "position": 4,
- "line": 1
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Great stuff",
+ "path": "file1.txt",
+ "position": 4,
+ "line": 1
+ }
+ }
}
}
}
@@ -28469,11 +28513,15 @@
"state"
]
},
- "example": {
- "state": "success",
- "target_url": "https://example.com/build/status",
- "description": "The build succeeded!",
- "context": "continuous-integration/jenkins"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "success",
+ "target_url": "https://example.com/build/status",
+ "description": "The build succeeded!",
+ "context": "continuous-integration/jenkins"
+ }
+ }
}
}
}
@@ -28693,10 +28741,14 @@
"key"
]
},
- "example": {
- "title": "octocat@octomac",
- "key": "ssh-rsa AAA...",
- "read_only": true
+ "examples": {
+ "default": {
+ "value": {
+ "title": "octocat@octomac",
+ "key": "ssh-rsa AAA...",
+ "read_only": true
+ }
+ }
}
}
}
@@ -29724,11 +29776,15 @@
"state"
]
},
- "example": {
- "environment": "production",
- "state": "success",
- "log_url": "https://example.com/deployment/42/output",
- "description": "Deployment finished successfully."
+ "examples": {
+ "default": {
+ "value": {
+ "environment": "production",
+ "state": "success",
+ "log_url": "https://example.com/deployment/42/output",
+ "description": "Deployment finished successfully."
+ }
+ }
}
}
}
@@ -30780,16 +30836,20 @@
"config"
]
},
- "example": {
- "name": "web",
- "events": [
- "organization",
- "user"
- ],
- "config": {
- "url": "https://example.com/webhook",
- "content_type": "json",
- "secret": "secret"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "events": [
+ "organization",
+ "user"
+ ],
+ "config": {
+ "url": "https://example.com/webhook",
+ "content_type": "json",
+ "secret": "secret"
+ }
+ }
}
}
}
@@ -31169,12 +31229,16 @@
}
}
},
- "example": {
- "events": [
- "organization"
- ],
- "config": {
- "url": "https://example.com/webhook"
+ "examples": {
+ "default": {
+ "value": {
+ "events": [
+ "organization"
+ ],
+ "config": {
+ "url": "https://example.com/webhook"
+ }
+ }
}
}
}
@@ -31493,8 +31557,12 @@
"ldap_dn"
]
},
- "example": {
- "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
+ "examples": {
+ "default": {
+ "value": {
+ "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
+ }
+ }
}
}
}
@@ -31626,8 +31694,12 @@
"ldap_dn"
]
},
- "example": {
- "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
+ "examples": {
+ "default": {
+ "value": {
+ "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
+ }
+ }
}
}
}
@@ -32601,9 +32673,13 @@
}
}
},
- "example": {
- "enforcement": "enabled",
- "allow_downstream_configuration": false
+ "examples": {
+ "default": {
+ "value": {
+ "enforcement": "enabled",
+ "allow_downstream_configuration": false
+ }
+ }
}
}
}
@@ -32771,10 +32847,14 @@
"admin"
]
},
- "example": {
- "login": "github",
- "profile_name": "GitHub, Inc.",
- "admin": "monalisaoctocat"
+ "examples": {
+ "default": {
+ "value": {
+ "login": "github",
+ "profile_name": "GitHub, Inc.",
+ "admin": "monalisaoctocat"
+ }
+ }
}
}
}
@@ -33049,9 +33129,13 @@
"image_url"
]
},
- "example": {
- "name": "DevTools Hook Env",
- "image_url": "https://my_file_server/path/to/devtools_env.tar.gz"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "DevTools Hook Env",
+ "image_url": "https://my_file_server/path/to/devtools_env.tar.gz"
+ }
+ }
}
}
}
@@ -33604,16 +33688,20 @@
"environment"
]
},
- "example": {
- "name": "Check Commits",
- "script": "scripts/commit_check.sh",
- "enforcement": "disabled",
- "allow_downstream_configuration": false,
- "script_repository": {
- "full_name": "DevIT/hooks"
- },
- "environment": {
- "id": 2
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Check Commits",
+ "script": "scripts/commit_check.sh",
+ "enforcement": "disabled",
+ "allow_downstream_configuration": false,
+ "script_repository": {
+ "full_name": "DevIT/hooks"
+ },
+ "environment": {
+ "id": 2
+ }
+ }
}
}
}
@@ -33848,12 +33936,16 @@
}
}
},
- "example": {
- "name": "Check Commits",
- "environment": {
- "id": 1
- },
- "allow_downstream_configuration": true
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Check Commits",
+ "environment": {
+ "id": 1
+ },
+ "allow_downstream_configuration": true
+ }
+ }
}
}
}
@@ -34242,8 +34334,12 @@
}
}
},
- "example": {
- "enforcement": "enabled"
+ "examples": {
+ "default": {
+ "value": {
+ "enforcement": "enabled"
+ }
+ }
}
}
}
@@ -34646,9 +34742,13 @@
"login"
]
},
- "example": {
- "login": "monalisa",
- "email": "octocat@github.com"
+ "examples": {
+ "default": {
+ "value": {
+ "login": "monalisa",
+ "email": "octocat@github.com"
+ }
+ }
}
}
}
@@ -37031,9 +37131,13 @@
"content"
]
},
- "example": {
- "content": "Content of the blob",
- "encoding": "utf-8"
+ "examples": {
+ "default": {
+ "value": {
+ "content": "Content of the blob",
+ "encoding": "utf-8"
+ }
+ }
}
}
}
@@ -37961,9 +38065,13 @@
"sha"
]
},
- "example": {
- "ref": "refs/heads/featureA",
- "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd"
+ "examples": {
+ "default": {
+ "value": {
+ "ref": "refs/heads/featureA",
+ "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd"
+ }
+ }
}
}
}
@@ -38099,9 +38207,13 @@
"sha"
]
},
- "example": {
- "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
- "force": true
+ "examples": {
+ "default": {
+ "value": {
+ "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
+ "force": true
+ }
+ }
}
}
}
@@ -38391,15 +38503,19 @@
"type"
]
},
- "example": {
- "tag": "v0.0.1",
- "message": "initial version",
- "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
- "type": "commit",
- "tagger": {
- "name": "Monalisa Octocat",
- "email": "octocat@github.com",
- "date": "2011-06-17T14:53:35-07:00"
+ "examples": {
+ "default": {
+ "value": {
+ "tag": "v0.0.1",
+ "message": "initial version",
+ "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
+ "type": "commit",
+ "tagger": {
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com",
+ "date": "2011-06-17T14:53:35-07:00"
+ }
+ }
}
}
}
@@ -38818,16 +38934,20 @@
"tree"
]
},
- "example": {
- "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
- "tree": [
- {
- "path": "file.rb",
- "mode": "100644",
- "type": "blob",
- "sha": "44b4fc6d56897b048c772eb4087f854f46256132"
+ "examples": {
+ "default": {
+ "value": {
+ "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
+ "tree": [
+ {
+ "path": "file.rb",
+ "mode": "100644",
+ "type": "blob",
+ "sha": "44b4fc6d56897b048c772eb4087f854f46256132"
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -39937,16 +40057,20 @@
"title"
]
},
- "example": {
- "title": "Found a bug",
- "body": "I'm having a problem with this.",
- "assignees": [
- "octocat"
- ],
- "milestone": 1,
- "labels": [
- "bug"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Found a bug",
+ "body": "I'm having a problem with this.",
+ "assignees": [
+ "octocat"
+ ],
+ "milestone": 1,
+ "labels": [
+ "bug"
+ ]
+ }
+ }
}
}
}
@@ -41152,11 +41276,15 @@
}
}
},
- "example": {
- "assignees": [
- "hubot",
- "other_user"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "assignees": [
+ "hubot",
+ "other_user"
+ ]
+ }
+ }
}
}
}
@@ -41258,11 +41386,15 @@
}
}
},
- "example": {
- "assignees": [
- "hubot",
- "other_user"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "assignees": [
+ "hubot",
+ "other_user"
+ ]
+ }
+ }
}
}
}
@@ -41576,8 +41708,12 @@
"body"
]
},
- "example": {
- "body": "Me too"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Me too"
+ }
+ }
}
}
}
@@ -41856,8 +41992,12 @@
"body"
]
},
- "example": {
- "body": "Me too"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Me too"
+ }
+ }
}
}
}
@@ -42385,11 +42525,15 @@
}
]
},
- "example": {
- "labels": [
- "bug",
- "enhancement"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "labels": [
+ "bug",
+ "enhancement"
+ ]
+ }
+ }
}
}
}
@@ -42553,11 +42697,15 @@
}
]
},
- "example": {
- "labels": [
- "bug",
- "enhancement"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "labels": [
+ "bug",
+ "enhancement"
+ ]
+ }
+ }
}
}
}
@@ -42909,10 +43057,14 @@
"name"
]
},
- "example": {
- "name": "bug",
- "description": "Something isn't working",
- "color": "f29513"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513"
+ }
+ }
}
}
}
@@ -43122,10 +43274,14 @@
}
}
},
- "example": {
- "new_name": "bug :bug:",
- "description": "Small bug fix required",
- "color": "b01f26"
+ "examples": {
+ "default": {
+ "value": {
+ "new_name": "bug :bug:",
+ "description": "Small bug fix required",
+ "color": "b01f26"
+ }
+ }
}
}
}
@@ -43539,11 +43695,15 @@
"title"
]
},
- "example": {
- "title": "v1.0",
- "state": "open",
- "description": "Tracking milestone for version 1.0",
- "due_on": "2012-10-09T23:39:01Z"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "v1.0",
+ "state": "open",
+ "description": "Tracking milestone for version 1.0",
+ "due_on": "2012-10-09T23:39:01Z"
+ }
+ }
}
}
}
@@ -43785,11 +43945,15 @@
}
}
},
- "example": {
- "title": "v1.0",
- "state": "open",
- "description": "Tracking milestone for version 1.0",
- "due_on": "2012-10-09T23:39:01Z"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "v1.0",
+ "state": "open",
+ "description": "Tracking milestone for version 1.0",
+ "due_on": "2012-10-09T23:39:01Z"
+ }
+ }
}
}
}
@@ -46451,17 +46615,21 @@
}
}
},
- "example": {
- "billing_email": "mona@github.com",
- "company": "GitHub",
- "email": "mona@github.com",
- "twitter_username": "github",
- "location": "San Francisco",
- "name": "github",
- "description": "GitHub, the company.",
- "default_repository_permission": "read",
- "members_can_create_repositories": true,
- "members_allowed_repository_creation_type": "all"
+ "examples": {
+ "default": {
+ "value": {
+ "billing_email": "mona@github.com",
+ "company": "GitHub",
+ "email": "mona@github.com",
+ "twitter_username": "github",
+ "location": "San Francisco",
+ "name": "github",
+ "description": "GitHub, the company.",
+ "default_repository_permission": "read",
+ "members_can_create_repositories": true,
+ "members_allowed_repository_creation_type": "all"
+ }
+ }
}
}
}
@@ -47761,8 +47929,12 @@
"state"
]
},
- "example": {
- "state": "active"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "active"
+ }
+ }
}
}
}
@@ -48346,16 +48518,20 @@
"config"
]
},
- "example": {
- "name": "web",
- "active": true,
- "events": [
- "push",
- "pull_request"
- ],
- "config": {
- "url": "http://example.com/webhook",
- "content_type": "json"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "url": "http://example.com/webhook",
+ "content_type": "json"
+ }
+ }
}
}
}
@@ -48876,11 +49052,15 @@
}
}
},
- "example": {
- "active": true,
- "events": [
- "pull_request"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "active": true,
+ "events": [
+ "pull_request"
+ ]
+ }
+ }
}
}
}
@@ -50446,9 +50626,13 @@
"name"
]
},
- "example": {
- "name": "Organization Roadmap",
- "body": "High-level roadmap for the upcoming year."
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Organization Roadmap",
+ "body": "High-level roadmap for the upcoming year."
+ }
+ }
}
}
}
@@ -51064,9 +51248,13 @@
"name"
]
},
- "example": {
- "name": "Projects Documentation",
- "body": "Developer documentation project for the developer site."
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Projects Documentation",
+ "body": "Developer documentation project for the developer site."
+ }
+ }
}
}
}
@@ -53351,11 +53539,15 @@
"base"
]
},
- "example": {
- "title": "Amazing new feature",
- "body": "Please pull these awesome changes in!",
- "head": "octocat:new-feature",
- "base": "master"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Amazing new feature",
+ "body": "Please pull these awesome changes in!",
+ "head": "octocat:new-feature",
+ "base": "master"
+ }
+ }
}
}
}
@@ -53636,11 +53828,15 @@
}
}
},
- "example": {
- "title": "new title",
- "body": "updated body",
- "state": "open",
- "base": "master"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "new title",
+ "body": "updated body",
+ "state": "open",
+ "base": "master"
+ }
+ }
}
}
}
@@ -54541,8 +54737,12 @@
"body"
]
},
- "example": {
- "body": "I like this too!"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "I like this too!"
+ }
+ }
}
}
}
@@ -55154,8 +55354,12 @@
"body"
]
},
- "example": {
- "body": "Great stuff!"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Great stuff!"
+ }
+ }
}
}
}
@@ -55369,15 +55573,19 @@
}
]
},
- "example": {
- "reviewers": [
- "octocat",
- "hubot",
- "other_user"
- ],
- "team_reviewers": [
- "justice-league"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "reviewers": [
+ "octocat",
+ "hubot",
+ "other_user"
+ ],
+ "team_reviewers": [
+ "justice-league"
+ ]
+ }
+ }
}
}
}
@@ -55916,17 +56124,21 @@
}
}
},
- "example": {
- "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
- "body": "This is close to perfect! Please address the suggested inline change.",
- "event": "REQUEST_CHANGES",
- "comments": [
- {
- "path": "file.md",
- "position": 6,
- "body": "Please add more information here, and fix this typo."
+ "examples": {
+ "default": {
+ "value": {
+ "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
+ "body": "This is close to perfect! Please address the suggested inline change.",
+ "event": "REQUEST_CHANGES",
+ "comments": [
+ {
+ "path": "file.md",
+ "position": 6,
+ "body": "Please add more information here, and fix this typo."
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -57811,7 +58023,7 @@
"content"
]
},
- "example": {
+ "examples": {
"default": {
"value": {
"content": "heart"
@@ -59145,8 +59357,12 @@
"content"
]
},
- "example": {
- "content": "heart"
+ "examples": {
+ "default": {
+ "value": {
+ "content": "heart"
+ }
+ }
}
}
}
@@ -59366,8 +59582,12 @@
"content"
]
},
- "example": {
- "content": "heart"
+ "examples": {
+ "default": {
+ "value": {
+ "content": "heart"
+ }
+ }
}
}
}
@@ -59605,13 +59825,17 @@
"tag_name"
]
},
- "example": {
- "tag_name": "v1.0.0",
- "target_commitish": "master",
- "name": "v1.0.0",
- "body": "Description of the release",
- "draft": false,
- "prerelease": false
+ "examples": {
+ "default": {
+ "value": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "master",
+ "name": "v1.0.0",
+ "body": "Description of the release",
+ "draft": false,
+ "prerelease": false
+ }
+ }
}
}
}
@@ -59999,13 +60223,17 @@
}
}
},
- "example": {
- "tag_name": "v1.0.0",
- "target_commitish": "master",
- "name": "v1.0.0",
- "body": "Description of the release",
- "draft": false,
- "prerelease": false
+ "examples": {
+ "default": {
+ "value": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "master",
+ "name": "v1.0.0",
+ "body": "Description of the release",
+ "draft": false,
+ "prerelease": false
+ }
+ }
}
}
}
@@ -60311,9 +60539,13 @@
}
}
},
- "example": {
- "name": "foo-1.0.0-osx.zip",
- "label": "Mac binary"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "foo-1.0.0-osx.zip",
+ "label": "Mac binary"
+ }
+ }
}
}
}
@@ -60956,14 +61188,18 @@
"name"
]
},
- "example": {
- "name": "Hello-World",
- "description": "This is your first repository",
- "homepage": "https://github.com",
- "private": false,
- "has_issues": true,
- "has_projects": true,
- "has_wiki": true
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Hello-World",
+ "description": "This is your first repository",
+ "homepage": "https://github.com",
+ "private": false,
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true
+ }
+ }
}
}
}
@@ -62327,13 +62563,17 @@
"names"
]
},
- "example": {
- "names": [
- "octocat",
- "atom",
- "electron",
- "api"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "names": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ]
+ }
+ }
}
}
}
@@ -62458,12 +62698,16 @@
"new_owner"
]
},
- "example": {
- "new_owner": "github",
- "team_ids": [
- 12,
- 345
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "new_owner": "github",
+ "team_ids": [
+ 12,
+ 345
+ ]
+ }
+ }
}
}
}
@@ -62603,12 +62847,16 @@
"name"
]
},
- "example": {
- "owner": "octocat",
- "name": "Hello-World",
- "description": "This is your first repository",
- "include_all_branches": false,
- "private": false
+ "examples": {
+ "default": {
+ "value": {
+ "owner": "octocat",
+ "name": "Hello-World",
+ "description": "This is your first repository",
+ "include_all_branches": false,
+ "private": false
+ }
+ }
}
}
}
@@ -64370,13 +64618,17 @@
"sha"
]
},
- "example": {
- "message": "my commit message",
- "committer": {
- "name": "Monalisa Octocat",
- "email": "octocat@github.com"
- },
- "sha": "329688480d39049927147c162b9d2deaf885005f"
+ "examples": {
+ "default": {
+ "value": {
+ "message": "my commit message",
+ "committer": {
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com"
+ },
+ "sha": "329688480d39049927147c162b9d2deaf885005f"
+ }
+ }
}
}
}
@@ -66122,9 +66374,13 @@
"state"
]
},
- "example": {
- "state": "resolved",
- "resolution": "false_positive"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "resolved",
+ "resolution": "false_positive"
+ }
+ }
}
}
}
@@ -66394,11 +66650,15 @@
"name"
]
},
- "example": {
- "name": "Justice League",
- "description": "A great team",
- "permission": "push",
- "privacy": "closed"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Justice League",
+ "description": "A great team",
+ "permission": "push",
+ "privacy": "closed"
+ }
+ }
}
}
}
@@ -66683,10 +66943,14 @@
}
}
},
- "example": {
- "name": "new team name",
- "description": "new team description",
- "privacy": "closed"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "new team name",
+ "description": "new team description",
+ "privacy": "closed"
+ }
+ }
}
}
}
@@ -68893,8 +69157,12 @@
"body"
]
},
- "example": {
- "body": "Do you like apples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like apples?"
+ }
+ }
}
}
}
@@ -69089,8 +69357,12 @@
"body"
]
},
- "example": {
- "body": "Do you like pineapples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like pineapples?"
+ }
+ }
}
}
}
@@ -69356,8 +69628,12 @@
"body"
]
},
- "example": {
- "body": "Do you like apples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like apples?"
+ }
+ }
}
}
}
@@ -69538,8 +69814,12 @@
"body"
]
},
- "example": {
- "body": "Do you like pineapples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like pineapples?"
+ }
+ }
}
}
}
@@ -69832,9 +70112,13 @@
"body"
]
},
- "example": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Our first team post",
+ "body": "Hi! This is an area for us to collaborate as a team."
+ }
+ }
}
}
}
@@ -70036,8 +70320,12 @@
}
}
},
- "example": {
- "title": "Welcome to our first team post"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Welcome to our first team post"
+ }
+ }
}
}
}
@@ -70305,9 +70593,13 @@
"body"
]
},
- "example": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Our first team post",
+ "body": "Hi! This is an area for us to collaborate as a team."
+ }
+ }
}
}
}
@@ -70495,8 +70787,12 @@
}
}
},
- "example": {
- "title": "Welcome to our first team post"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Welcome to our first team post"
+ }
+ }
}
}
}
@@ -74292,17 +74588,21 @@
},
"additionalProperties": false
},
- "example": {
- "name": "web",
- "active": true,
- "events": [
- "push",
- "pull_request"
- ],
- "config": {
- "url": "https://example.com/webhook",
- "content_type": "json",
- "insecure_ssl": "0"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "url": "https://example.com/webhook",
+ "content_type": "json",
+ "insecure_ssl": "0"
+ }
+ }
}
}
}
@@ -74900,11 +75200,15 @@
}
}
},
- "example": {
- "active": true,
- "add_events": [
- "pull_request"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "active": true,
+ "add_events": [
+ "pull_request"
+ ]
+ }
+ }
}
}
}
diff --git a/lib/rest/static/decorated/ghes-3.2.json b/lib/rest/static/decorated/ghes-3.2.json
index 9032cf5fad1c..630b5dfaebc8 100644
--- a/lib/rest/static/decorated/ghes-3.2.json
+++ b/lib/rest/static/decorated/ghes-3.2.json
@@ -1590,7 +1590,7 @@
"subcategory": "permissions",
"notes": [],
"bodyParameters": [],
- "descriptionHTML": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint. GitHub Apps must have the administration repository permission to use this API.
",
+ "descriptionHTML": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.
",
"responses": [
{
"httpStatusCode": "200",
@@ -3531,17 +3531,21 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected",
- "selected_organization_ids": [
- 32,
- 91
- ],
- "runners": [
- 9,
- 2
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected",
+ "selected_organization_ids": [
+ 32,
+ 91
+ ],
+ "runners": [
+ 9,
+ 2
+ ]
+ }
+ }
}
}
}
@@ -3759,9 +3763,13 @@
}
}
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected"
+ }
+ }
}
}
}
@@ -4655,17 +4663,21 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected",
- "selected_repository_ids": [
- 32,
- 91
- ],
- "runners": [
- 9,
- 2
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected",
+ "selected_repository_ids": [
+ 32,
+ 91
+ ],
+ "runners": [
+ 9,
+ 2
+ ]
+ }
+ }
}
}
}
@@ -4886,9 +4898,13 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected"
+ }
+ }
}
}
}
@@ -16843,8 +16859,12 @@
"new_name"
]
},
- "example": {
- "new_name": "my_renamed_branch"
+ "examples": {
+ "default": {
+ "value": {
+ "new_name": "my_renamed_branch"
+ }
+ }
}
}
}
@@ -18159,26 +18179,30 @@
}
}
},
- "example": {
- "dismissal_restrictions": {
- "users": [
- "octocat"
- ],
- "teams": [
- "justice-league"
- ]
- },
- "bypass_pull_request_allowances": {
- "users": [
- "octocat"
- ],
- "teams": [
- "justice-league"
- ]
- },
- "dismiss_stale_reviews": true,
- "require_code_owner_reviews": true,
- "required_approving_review_count": 2
+ "examples": {
+ "default": {
+ "value": {
+ "dismissal_restrictions": {
+ "users": [
+ "octocat"
+ ],
+ "teams": [
+ "justice-league"
+ ]
+ },
+ "bypass_pull_request_allowances": {
+ "users": [
+ "octocat"
+ ],
+ "teams": [
+ "justice-league"
+ ]
+ },
+ "dismiss_stale_reviews": true,
+ "require_code_owner_reviews": true,
+ "required_approving_review_count": 2
+ }
+ }
}
}
}
@@ -18751,11 +18775,15 @@
}
}
},
- "example": {
- "strict": true,
- "contexts": [
- "continuous-integration/travis-ci"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "strict": true,
+ "contexts": [
+ "continuous-integration/travis-ci"
+ ]
+ }
+ }
}
}
}
@@ -25534,13 +25562,17 @@
}
}
},
- "example": {
- "auto_trigger_checks": [
- {
- "app_id": 4,
- "setting": false
+ "examples": {
+ "default": {
+ "value": {
+ "auto_trigger_checks": [
+ {
+ "app_id": 4,
+ "setting": false
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -26179,9 +26211,13 @@
"state"
]
},
- "example": {
- "state": "dismissed",
- "dismissed_reason": "false positive"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "dismissed",
+ "dismissed_reason": "false positive"
+ }
+ }
}
}
}
@@ -28704,8 +28740,12 @@
"body"
]
},
- "example": {
- "body": "Nice change"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Nice change"
+ }
+ }
}
}
}
@@ -28997,11 +29037,15 @@
"body"
]
},
- "example": {
- "body": "Great stuff",
- "path": "file1.txt",
- "position": 4,
- "line": 1
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Great stuff",
+ "path": "file1.txt",
+ "position": 4,
+ "line": 1
+ }
+ }
}
}
}
@@ -29355,11 +29399,15 @@
"state"
]
},
- "example": {
- "state": "success",
- "target_url": "https://example.com/build/status",
- "description": "The build succeeded!",
- "context": "continuous-integration/jenkins"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "success",
+ "target_url": "https://example.com/build/status",
+ "description": "The build succeeded!",
+ "context": "continuous-integration/jenkins"
+ }
+ }
}
}
}
@@ -29579,10 +29627,14 @@
"key"
]
},
- "example": {
- "title": "octocat@octomac",
- "key": "ssh-rsa AAA...",
- "read_only": true
+ "examples": {
+ "default": {
+ "value": {
+ "title": "octocat@octomac",
+ "key": "ssh-rsa AAA...",
+ "read_only": true
+ }
+ }
}
}
}
@@ -31023,11 +31075,15 @@
"state"
]
},
- "example": {
- "environment": "production",
- "state": "success",
- "log_url": "https://example.com/deployment/42/output",
- "description": "Deployment finished successfully."
+ "examples": {
+ "default": {
+ "value": {
+ "environment": "production",
+ "state": "success",
+ "log_url": "https://example.com/deployment/42/output",
+ "description": "Deployment finished successfully."
+ }
+ }
}
}
}
@@ -32079,16 +32135,20 @@
"config"
]
},
- "example": {
- "name": "web",
- "events": [
- "organization",
- "user"
- ],
- "config": {
- "url": "https://example.com/webhook",
- "content_type": "json",
- "secret": "secret"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "events": [
+ "organization",
+ "user"
+ ],
+ "config": {
+ "url": "https://example.com/webhook",
+ "content_type": "json",
+ "secret": "secret"
+ }
+ }
}
}
}
@@ -32468,12 +32528,16 @@
}
}
},
- "example": {
- "events": [
- "organization"
- ],
- "config": {
- "url": "https://example.com/webhook"
+ "examples": {
+ "default": {
+ "value": {
+ "events": [
+ "organization"
+ ],
+ "config": {
+ "url": "https://example.com/webhook"
+ }
+ }
}
}
}
@@ -32792,8 +32856,12 @@
"ldap_dn"
]
},
- "example": {
- "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
+ "examples": {
+ "default": {
+ "value": {
+ "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
+ }
+ }
}
}
}
@@ -32925,8 +32993,12 @@
"ldap_dn"
]
},
- "example": {
- "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
+ "examples": {
+ "default": {
+ "value": {
+ "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
+ }
+ }
}
}
}
@@ -33900,9 +33972,13 @@
}
}
},
- "example": {
- "enforcement": "enabled",
- "allow_downstream_configuration": false
+ "examples": {
+ "default": {
+ "value": {
+ "enforcement": "enabled",
+ "allow_downstream_configuration": false
+ }
+ }
}
}
}
@@ -34070,10 +34146,14 @@
"admin"
]
},
- "example": {
- "login": "github",
- "profile_name": "GitHub, Inc.",
- "admin": "monalisaoctocat"
+ "examples": {
+ "default": {
+ "value": {
+ "login": "github",
+ "profile_name": "GitHub, Inc.",
+ "admin": "monalisaoctocat"
+ }
+ }
}
}
}
@@ -34348,9 +34428,13 @@
"image_url"
]
},
- "example": {
- "name": "DevTools Hook Env",
- "image_url": "https://my_file_server/path/to/devtools_env.tar.gz"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "DevTools Hook Env",
+ "image_url": "https://my_file_server/path/to/devtools_env.tar.gz"
+ }
+ }
}
}
}
@@ -34903,16 +34987,20 @@
"environment"
]
},
- "example": {
- "name": "Check Commits",
- "script": "scripts/commit_check.sh",
- "enforcement": "disabled",
- "allow_downstream_configuration": false,
- "script_repository": {
- "full_name": "DevIT/hooks"
- },
- "environment": {
- "id": 2
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Check Commits",
+ "script": "scripts/commit_check.sh",
+ "enforcement": "disabled",
+ "allow_downstream_configuration": false,
+ "script_repository": {
+ "full_name": "DevIT/hooks"
+ },
+ "environment": {
+ "id": 2
+ }
+ }
}
}
}
@@ -35147,12 +35235,16 @@
}
}
},
- "example": {
- "name": "Check Commits",
- "environment": {
- "id": 1
- },
- "allow_downstream_configuration": true
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Check Commits",
+ "environment": {
+ "id": 1
+ },
+ "allow_downstream_configuration": true
+ }
+ }
}
}
}
@@ -35541,8 +35633,12 @@
}
}
},
- "example": {
- "enforcement": "enabled"
+ "examples": {
+ "default": {
+ "value": {
+ "enforcement": "enabled"
+ }
+ }
}
}
}
@@ -35945,9 +36041,13 @@
"login"
]
},
- "example": {
- "login": "monalisa",
- "email": "octocat@github.com"
+ "examples": {
+ "default": {
+ "value": {
+ "login": "monalisa",
+ "email": "octocat@github.com"
+ }
+ }
}
}
}
@@ -38330,9 +38430,13 @@
"content"
]
},
- "example": {
- "content": "Content of the blob",
- "encoding": "utf-8"
+ "examples": {
+ "default": {
+ "value": {
+ "content": "Content of the blob",
+ "encoding": "utf-8"
+ }
+ }
}
}
}
@@ -39260,9 +39364,13 @@
"sha"
]
},
- "example": {
- "ref": "refs/heads/featureA",
- "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd"
+ "examples": {
+ "default": {
+ "value": {
+ "ref": "refs/heads/featureA",
+ "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd"
+ }
+ }
}
}
}
@@ -39398,9 +39506,13 @@
"sha"
]
},
- "example": {
- "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
- "force": true
+ "examples": {
+ "default": {
+ "value": {
+ "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
+ "force": true
+ }
+ }
}
}
}
@@ -39690,15 +39802,19 @@
"type"
]
},
- "example": {
- "tag": "v0.0.1",
- "message": "initial version",
- "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
- "type": "commit",
- "tagger": {
- "name": "Monalisa Octocat",
- "email": "octocat@github.com",
- "date": "2011-06-17T14:53:35-07:00"
+ "examples": {
+ "default": {
+ "value": {
+ "tag": "v0.0.1",
+ "message": "initial version",
+ "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
+ "type": "commit",
+ "tagger": {
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com",
+ "date": "2011-06-17T14:53:35-07:00"
+ }
+ }
}
}
}
@@ -40117,16 +40233,20 @@
"tree"
]
},
- "example": {
- "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
- "tree": [
- {
- "path": "file.rb",
- "mode": "100644",
- "type": "blob",
- "sha": "44b4fc6d56897b048c772eb4087f854f46256132"
+ "examples": {
+ "default": {
+ "value": {
+ "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
+ "tree": [
+ {
+ "path": "file.rb",
+ "mode": "100644",
+ "type": "blob",
+ "sha": "44b4fc6d56897b048c772eb4087f854f46256132"
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -41236,16 +41356,20 @@
"title"
]
},
- "example": {
- "title": "Found a bug",
- "body": "I'm having a problem with this.",
- "assignees": [
- "octocat"
- ],
- "milestone": 1,
- "labels": [
- "bug"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Found a bug",
+ "body": "I'm having a problem with this.",
+ "assignees": [
+ "octocat"
+ ],
+ "milestone": 1,
+ "labels": [
+ "bug"
+ ]
+ }
+ }
}
}
}
@@ -42451,11 +42575,15 @@
}
}
},
- "example": {
- "assignees": [
- "hubot",
- "other_user"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "assignees": [
+ "hubot",
+ "other_user"
+ ]
+ }
+ }
}
}
}
@@ -42557,11 +42685,15 @@
}
}
},
- "example": {
- "assignees": [
- "hubot",
- "other_user"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "assignees": [
+ "hubot",
+ "other_user"
+ ]
+ }
+ }
}
}
}
@@ -42875,8 +43007,12 @@
"body"
]
},
- "example": {
- "body": "Me too"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Me too"
+ }
+ }
}
}
}
@@ -43155,8 +43291,12 @@
"body"
]
},
- "example": {
- "body": "Me too"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Me too"
+ }
+ }
}
}
}
@@ -43684,11 +43824,15 @@
}
]
},
- "example": {
- "labels": [
- "bug",
- "enhancement"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "labels": [
+ "bug",
+ "enhancement"
+ ]
+ }
+ }
}
}
}
@@ -43852,11 +43996,15 @@
}
]
},
- "example": {
- "labels": [
- "bug",
- "enhancement"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "labels": [
+ "bug",
+ "enhancement"
+ ]
+ }
+ }
}
}
}
@@ -44208,10 +44356,14 @@
"name"
]
},
- "example": {
- "name": "bug",
- "description": "Something isn't working",
- "color": "f29513"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513"
+ }
+ }
}
}
}
@@ -44421,10 +44573,14 @@
}
}
},
- "example": {
- "new_name": "bug :bug:",
- "description": "Small bug fix required",
- "color": "b01f26"
+ "examples": {
+ "default": {
+ "value": {
+ "new_name": "bug :bug:",
+ "description": "Small bug fix required",
+ "color": "b01f26"
+ }
+ }
}
}
}
@@ -44838,11 +44994,15 @@
"title"
]
},
- "example": {
- "title": "v1.0",
- "state": "open",
- "description": "Tracking milestone for version 1.0",
- "due_on": "2012-10-09T23:39:01Z"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "v1.0",
+ "state": "open",
+ "description": "Tracking milestone for version 1.0",
+ "due_on": "2012-10-09T23:39:01Z"
+ }
+ }
}
}
}
@@ -45084,11 +45244,15 @@
}
}
},
- "example": {
- "title": "v1.0",
- "state": "open",
- "description": "Tracking milestone for version 1.0",
- "due_on": "2012-10-09T23:39:01Z"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "v1.0",
+ "state": "open",
+ "description": "Tracking milestone for version 1.0",
+ "due_on": "2012-10-09T23:39:01Z"
+ }
+ }
}
}
}
@@ -47750,17 +47914,21 @@
}
}
},
- "example": {
- "billing_email": "mona@github.com",
- "company": "GitHub",
- "email": "mona@github.com",
- "twitter_username": "github",
- "location": "San Francisco",
- "name": "github",
- "description": "GitHub, the company.",
- "default_repository_permission": "read",
- "members_can_create_repositories": true,
- "members_allowed_repository_creation_type": "all"
+ "examples": {
+ "default": {
+ "value": {
+ "billing_email": "mona@github.com",
+ "company": "GitHub",
+ "email": "mona@github.com",
+ "twitter_username": "github",
+ "location": "San Francisco",
+ "name": "github",
+ "description": "GitHub, the company.",
+ "default_repository_permission": "read",
+ "members_can_create_repositories": true,
+ "members_allowed_repository_creation_type": "all"
+ }
+ }
}
}
}
@@ -49060,8 +49228,12 @@
"state"
]
},
- "example": {
- "state": "active"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "active"
+ }
+ }
}
}
}
@@ -49645,16 +49817,20 @@
"config"
]
},
- "example": {
- "name": "web",
- "active": true,
- "events": [
- "push",
- "pull_request"
- ],
- "config": {
- "url": "http://example.com/webhook",
- "content_type": "json"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "url": "http://example.com/webhook",
+ "content_type": "json"
+ }
+ }
}
}
}
@@ -50175,11 +50351,15 @@
}
}
},
- "example": {
- "active": true,
- "events": [
- "pull_request"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "active": true,
+ "events": [
+ "pull_request"
+ ]
+ }
+ }
}
}
}
@@ -51974,9 +52154,13 @@
"name"
]
},
- "example": {
- "name": "Organization Roadmap",
- "body": "High-level roadmap for the upcoming year."
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Organization Roadmap",
+ "body": "High-level roadmap for the upcoming year."
+ }
+ }
}
}
}
@@ -52592,9 +52776,13 @@
"name"
]
},
- "example": {
- "name": "Projects Documentation",
- "body": "Developer documentation project for the developer site."
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Projects Documentation",
+ "body": "Developer documentation project for the developer site."
+ }
+ }
}
}
}
@@ -54879,11 +55067,15 @@
"base"
]
},
- "example": {
- "title": "Amazing new feature",
- "body": "Please pull these awesome changes in!",
- "head": "octocat:new-feature",
- "base": "master"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Amazing new feature",
+ "body": "Please pull these awesome changes in!",
+ "head": "octocat:new-feature",
+ "base": "master"
+ }
+ }
}
}
}
@@ -55164,11 +55356,15 @@
}
}
},
- "example": {
- "title": "new title",
- "body": "updated body",
- "state": "open",
- "base": "master"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "new title",
+ "body": "updated body",
+ "state": "open",
+ "base": "master"
+ }
+ }
}
}
}
@@ -56069,8 +56265,12 @@
"body"
]
},
- "example": {
- "body": "I like this too!"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "I like this too!"
+ }
+ }
}
}
}
@@ -56682,8 +56882,12 @@
"body"
]
},
- "example": {
- "body": "Great stuff!"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Great stuff!"
+ }
+ }
}
}
}
@@ -56897,15 +57101,19 @@
}
]
},
- "example": {
- "reviewers": [
- "octocat",
- "hubot",
- "other_user"
- ],
- "team_reviewers": [
- "justice-league"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "reviewers": [
+ "octocat",
+ "hubot",
+ "other_user"
+ ],
+ "team_reviewers": [
+ "justice-league"
+ ]
+ }
+ }
}
}
}
@@ -57444,17 +57652,21 @@
}
}
},
- "example": {
- "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
- "body": "This is close to perfect! Please address the suggested inline change.",
- "event": "REQUEST_CHANGES",
- "comments": [
- {
- "path": "file.md",
- "position": 6,
- "body": "Please add more information here, and fix this typo."
+ "examples": {
+ "default": {
+ "value": {
+ "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
+ "body": "This is close to perfect! Please address the suggested inline change.",
+ "event": "REQUEST_CHANGES",
+ "comments": [
+ {
+ "path": "file.md",
+ "position": 6,
+ "body": "Please add more information here, and fix this typo."
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -59339,7 +59551,7 @@
"content"
]
},
- "example": {
+ "examples": {
"default": {
"value": {
"content": "heart"
@@ -61004,8 +61216,12 @@
"content"
]
},
- "example": {
- "content": "heart"
+ "examples": {
+ "default": {
+ "value": {
+ "content": "heart"
+ }
+ }
}
}
}
@@ -61225,8 +61441,12 @@
"content"
]
},
- "example": {
- "content": "heart"
+ "examples": {
+ "default": {
+ "value": {
+ "content": "heart"
+ }
+ }
}
}
}
@@ -61464,13 +61684,17 @@
"tag_name"
]
},
- "example": {
- "tag_name": "v1.0.0",
- "target_commitish": "master",
- "name": "v1.0.0",
- "body": "Description of the release",
- "draft": false,
- "prerelease": false
+ "examples": {
+ "default": {
+ "value": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "master",
+ "name": "v1.0.0",
+ "body": "Description of the release",
+ "draft": false,
+ "prerelease": false
+ }
+ }
}
}
}
@@ -61858,13 +62082,17 @@
}
}
},
- "example": {
- "tag_name": "v1.0.0",
- "target_commitish": "master",
- "name": "v1.0.0",
- "body": "Description of the release",
- "draft": false,
- "prerelease": false
+ "examples": {
+ "default": {
+ "value": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "master",
+ "name": "v1.0.0",
+ "body": "Description of the release",
+ "draft": false,
+ "prerelease": false
+ }
+ }
}
}
}
@@ -62170,9 +62398,13 @@
}
}
},
- "example": {
- "name": "foo-1.0.0-osx.zip",
- "label": "Mac binary"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "foo-1.0.0-osx.zip",
+ "label": "Mac binary"
+ }
+ }
}
}
}
@@ -62825,14 +63057,18 @@
"name"
]
},
- "example": {
- "name": "Hello-World",
- "description": "This is your first repository",
- "homepage": "https://github.com",
- "private": false,
- "has_issues": true,
- "has_projects": true,
- "has_wiki": true
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Hello-World",
+ "description": "This is your first repository",
+ "homepage": "https://github.com",
+ "private": false,
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true
+ }
+ }
}
}
}
@@ -64296,13 +64532,17 @@
"names"
]
},
- "example": {
- "names": [
- "octocat",
- "atom",
- "electron",
- "api"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "names": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ]
+ }
+ }
}
}
}
@@ -64427,12 +64667,16 @@
"new_owner"
]
},
- "example": {
- "new_owner": "github",
- "team_ids": [
- 12,
- 345
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "new_owner": "github",
+ "team_ids": [
+ 12,
+ 345
+ ]
+ }
+ }
}
}
}
@@ -64572,12 +64816,16 @@
"name"
]
},
- "example": {
- "owner": "octocat",
- "name": "Hello-World",
- "description": "This is your first repository",
- "include_all_branches": false,
- "private": false
+ "examples": {
+ "default": {
+ "value": {
+ "owner": "octocat",
+ "name": "Hello-World",
+ "description": "This is your first repository",
+ "include_all_branches": false,
+ "private": false
+ }
+ }
}
}
}
@@ -66356,13 +66604,17 @@
"sha"
]
},
- "example": {
- "message": "my commit message",
- "committer": {
- "name": "Monalisa Octocat",
- "email": "octocat@github.com"
- },
- "sha": "329688480d39049927147c162b9d2deaf885005f"
+ "examples": {
+ "default": {
+ "value": {
+ "message": "my commit message",
+ "committer": {
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com"
+ },
+ "sha": "329688480d39049927147c162b9d2deaf885005f"
+ }
+ }
}
}
}
@@ -68108,9 +68360,13 @@
"state"
]
},
- "example": {
- "state": "resolved",
- "resolution": "false_positive"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "resolved",
+ "resolution": "false_positive"
+ }
+ }
}
}
}
@@ -68380,11 +68636,15 @@
"name"
]
},
- "example": {
- "name": "Justice League",
- "description": "A great team",
- "permission": "push",
- "privacy": "closed"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Justice League",
+ "description": "A great team",
+ "permission": "push",
+ "privacy": "closed"
+ }
+ }
}
}
}
@@ -68669,10 +68929,14 @@
}
}
},
- "example": {
- "name": "new team name",
- "description": "new team description",
- "privacy": "closed"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "new team name",
+ "description": "new team description",
+ "privacy": "closed"
+ }
+ }
}
}
}
@@ -70879,8 +71143,12 @@
"body"
]
},
- "example": {
- "body": "Do you like apples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like apples?"
+ }
+ }
}
}
}
@@ -71075,8 +71343,12 @@
"body"
]
},
- "example": {
- "body": "Do you like pineapples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like pineapples?"
+ }
+ }
}
}
}
@@ -71342,8 +71614,12 @@
"body"
]
},
- "example": {
- "body": "Do you like apples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like apples?"
+ }
+ }
}
}
}
@@ -71524,8 +71800,12 @@
"body"
]
},
- "example": {
- "body": "Do you like pineapples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like pineapples?"
+ }
+ }
}
}
}
@@ -71818,9 +72098,13 @@
"body"
]
},
- "example": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Our first team post",
+ "body": "Hi! This is an area for us to collaborate as a team."
+ }
+ }
}
}
}
@@ -72022,8 +72306,12 @@
}
}
},
- "example": {
- "title": "Welcome to our first team post"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Welcome to our first team post"
+ }
+ }
}
}
}
@@ -72291,9 +72579,13 @@
"body"
]
},
- "example": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Our first team post",
+ "body": "Hi! This is an area for us to collaborate as a team."
+ }
+ }
}
}
}
@@ -72481,8 +72773,12 @@
}
}
},
- "example": {
- "title": "Welcome to our first team post"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Welcome to our first team post"
+ }
+ }
}
}
}
@@ -76536,17 +76832,21 @@
},
"additionalProperties": false
},
- "example": {
- "name": "web",
- "active": true,
- "events": [
- "push",
- "pull_request"
- ],
- "config": {
- "url": "https://example.com/webhook",
- "content_type": "json",
- "insecure_ssl": "0"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "url": "https://example.com/webhook",
+ "content_type": "json",
+ "insecure_ssl": "0"
+ }
+ }
}
}
}
@@ -77144,11 +77444,15 @@
}
}
},
- "example": {
- "active": true,
- "add_events": [
- "pull_request"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "active": true,
+ "add_events": [
+ "pull_request"
+ ]
+ }
+ }
}
}
}
diff --git a/lib/rest/static/decorated/ghes-3.3.json b/lib/rest/static/decorated/ghes-3.3.json
index 19af692325a9..fa60ce200ea4 100644
--- a/lib/rest/static/decorated/ghes-3.3.json
+++ b/lib/rest/static/decorated/ghes-3.3.json
@@ -1590,7 +1590,7 @@
"subcategory": "permissions",
"notes": [],
"bodyParameters": [],
- "descriptionHTML": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint. GitHub Apps must have the administration repository permission to use this API.
",
+ "descriptionHTML": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.
",
"responses": [
{
"httpStatusCode": "200",
@@ -3531,17 +3531,21 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected",
- "selected_organization_ids": [
- 32,
- 91
- ],
- "runners": [
- 9,
- 2
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected",
+ "selected_organization_ids": [
+ 32,
+ 91
+ ],
+ "runners": [
+ 9,
+ 2
+ ]
+ }
+ }
}
}
}
@@ -3759,9 +3763,13 @@
}
}
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected"
+ }
+ }
}
}
}
@@ -4655,17 +4663,21 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected",
- "selected_repository_ids": [
- 32,
- 91
- ],
- "runners": [
- 9,
- 2
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected",
+ "selected_repository_ids": [
+ 32,
+ 91
+ ],
+ "runners": [
+ 9,
+ 2
+ ]
+ }
+ }
}
}
}
@@ -4886,9 +4898,13 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected"
+ }
+ }
}
}
}
@@ -16831,8 +16847,12 @@
"new_name"
]
},
- "example": {
- "new_name": "my_renamed_branch"
+ "examples": {
+ "default": {
+ "value": {
+ "new_name": "my_renamed_branch"
+ }
+ }
}
}
}
@@ -16937,8 +16957,12 @@
"branch"
]
},
- "example": {
- "branch": "main"
+ "examples": {
+ "default": {
+ "value": {
+ "branch": "main"
+ }
+ }
}
}
}
@@ -18230,26 +18254,30 @@
}
}
},
- "example": {
- "dismissal_restrictions": {
- "users": [
- "octocat"
- ],
- "teams": [
- "justice-league"
- ]
- },
- "bypass_pull_request_allowances": {
- "users": [
- "octocat"
- ],
- "teams": [
- "justice-league"
- ]
- },
- "dismiss_stale_reviews": true,
- "require_code_owner_reviews": true,
- "required_approving_review_count": 2
+ "examples": {
+ "default": {
+ "value": {
+ "dismissal_restrictions": {
+ "users": [
+ "octocat"
+ ],
+ "teams": [
+ "justice-league"
+ ]
+ },
+ "bypass_pull_request_allowances": {
+ "users": [
+ "octocat"
+ ],
+ "teams": [
+ "justice-league"
+ ]
+ },
+ "dismiss_stale_reviews": true,
+ "require_code_owner_reviews": true,
+ "required_approving_review_count": 2
+ }
+ }
}
}
}
@@ -18798,11 +18826,15 @@
}
}
},
- "example": {
- "strict": true,
- "contexts": [
- "continuous-integration/travis-ci"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "strict": true,
+ "contexts": [
+ "continuous-integration/travis-ci"
+ ]
+ }
+ }
}
}
}
@@ -25665,13 +25697,17 @@
}
}
},
- "example": {
- "auto_trigger_checks": [
- {
- "app_id": 4,
- "setting": false
+ "examples": {
+ "default": {
+ "value": {
+ "auto_trigger_checks": [
+ {
+ "app_id": 4,
+ "setting": false
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -26310,9 +26346,13 @@
"state"
]
},
- "example": {
- "state": "dismissed",
- "dismissed_reason": "false positive"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "dismissed",
+ "dismissed_reason": "false positive"
+ }
+ }
}
}
}
@@ -28811,8 +28851,12 @@
"body"
]
},
- "example": {
- "body": "Nice change"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Nice change"
+ }
+ }
}
}
}
@@ -29098,11 +29142,15 @@
"body"
]
},
- "example": {
- "body": "Great stuff",
- "path": "file1.txt",
- "position": 4,
- "line": 1
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Great stuff",
+ "path": "file1.txt",
+ "position": 4,
+ "line": 1
+ }
+ }
}
}
}
@@ -29456,11 +29504,15 @@
"state"
]
},
- "example": {
- "state": "success",
- "target_url": "https://example.com/build/status",
- "description": "The build succeeded!",
- "context": "continuous-integration/jenkins"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "success",
+ "target_url": "https://example.com/build/status",
+ "description": "The build succeeded!",
+ "context": "continuous-integration/jenkins"
+ }
+ }
}
}
}
@@ -29680,10 +29732,14 @@
"key"
]
},
- "example": {
- "title": "octocat@octomac",
- "key": "ssh-rsa AAA...",
- "read_only": true
+ "examples": {
+ "default": {
+ "value": {
+ "title": "octocat@octomac",
+ "key": "ssh-rsa AAA...",
+ "read_only": true
+ }
+ }
}
}
}
@@ -31092,11 +31148,15 @@
"state"
]
},
- "example": {
- "environment": "production",
- "state": "success",
- "log_url": "https://example.com/deployment/42/output",
- "description": "Deployment finished successfully."
+ "examples": {
+ "default": {
+ "value": {
+ "environment": "production",
+ "state": "success",
+ "log_url": "https://example.com/deployment/42/output",
+ "description": "Deployment finished successfully."
+ }
+ }
}
}
}
@@ -32222,16 +32282,20 @@
"config"
]
},
- "example": {
- "name": "web",
- "events": [
- "organization",
- "user"
- ],
- "config": {
- "url": "https://example.com/webhook",
- "content_type": "json",
- "secret": "secret"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "events": [
+ "organization",
+ "user"
+ ],
+ "config": {
+ "url": "https://example.com/webhook",
+ "content_type": "json",
+ "secret": "secret"
+ }
+ }
}
}
}
@@ -32577,12 +32641,16 @@
}
}
},
- "example": {
- "events": [
- "organization"
- ],
- "config": {
- "url": "https://example.com/webhook"
+ "examples": {
+ "default": {
+ "value": {
+ "events": [
+ "organization"
+ ],
+ "config": {
+ "url": "https://example.com/webhook"
+ }
+ }
}
}
}
@@ -32883,8 +32951,12 @@
"ldap_dn"
]
},
- "example": {
- "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
+ "examples": {
+ "default": {
+ "value": {
+ "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
+ }
+ }
}
}
}
@@ -33010,8 +33082,12 @@
"ldap_dn"
]
},
- "example": {
- "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
+ "examples": {
+ "default": {
+ "value": {
+ "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
+ }
+ }
}
}
}
@@ -33973,9 +34049,13 @@
}
}
},
- "example": {
- "enforcement": "enabled",
- "allow_downstream_configuration": false
+ "examples": {
+ "default": {
+ "value": {
+ "enforcement": "enabled",
+ "allow_downstream_configuration": false
+ }
+ }
}
}
}
@@ -34131,10 +34211,14 @@
"admin"
]
},
- "example": {
- "login": "github",
- "profile_name": "GitHub, Inc.",
- "admin": "monalisaoctocat"
+ "examples": {
+ "default": {
+ "value": {
+ "login": "github",
+ "profile_name": "GitHub, Inc.",
+ "admin": "monalisaoctocat"
+ }
+ }
}
}
}
@@ -34403,9 +34487,13 @@
"image_url"
]
},
- "example": {
- "name": "DevTools Hook Env",
- "image_url": "https://my_file_server/path/to/devtools_env.tar.gz"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "DevTools Hook Env",
+ "image_url": "https://my_file_server/path/to/devtools_env.tar.gz"
+ }
+ }
}
}
}
@@ -34916,16 +35004,20 @@
"environment"
]
},
- "example": {
- "name": "Check Commits",
- "script": "scripts/commit_check.sh",
- "enforcement": "disabled",
- "allow_downstream_configuration": false,
- "script_repository": {
- "full_name": "DevIT/hooks"
- },
- "environment": {
- "id": 2
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Check Commits",
+ "script": "scripts/commit_check.sh",
+ "enforcement": "disabled",
+ "allow_downstream_configuration": false,
+ "script_repository": {
+ "full_name": "DevIT/hooks"
+ },
+ "environment": {
+ "id": 2
+ }
+ }
}
}
}
@@ -35148,12 +35240,16 @@
}
}
},
- "example": {
- "name": "Check Commits",
- "environment": {
- "id": 1
- },
- "allow_downstream_configuration": true
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Check Commits",
+ "environment": {
+ "id": 1
+ },
+ "allow_downstream_configuration": true
+ }
+ }
}
}
}
@@ -35518,8 +35614,12 @@
}
}
},
- "example": {
- "enforcement": "enabled"
+ "examples": {
+ "default": {
+ "value": {
+ "enforcement": "enabled"
+ }
+ }
}
}
}
@@ -35910,9 +36010,13 @@
"login"
]
},
- "example": {
- "login": "monalisa",
- "email": "octocat@github.com"
+ "examples": {
+ "default": {
+ "value": {
+ "login": "monalisa",
+ "email": "octocat@github.com"
+ }
+ }
}
}
}
@@ -38295,9 +38399,13 @@
"content"
]
},
- "example": {
- "content": "Content of the blob",
- "encoding": "utf-8"
+ "examples": {
+ "default": {
+ "value": {
+ "content": "Content of the blob",
+ "encoding": "utf-8"
+ }
+ }
}
}
}
@@ -39225,9 +39333,13 @@
"sha"
]
},
- "example": {
- "ref": "refs/heads/featureA",
- "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd"
+ "examples": {
+ "default": {
+ "value": {
+ "ref": "refs/heads/featureA",
+ "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd"
+ }
+ }
}
}
}
@@ -39363,9 +39475,13 @@
"sha"
]
},
- "example": {
- "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
- "force": true
+ "examples": {
+ "default": {
+ "value": {
+ "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
+ "force": true
+ }
+ }
}
}
}
@@ -39655,15 +39771,19 @@
"type"
]
},
- "example": {
- "tag": "v0.0.1",
- "message": "initial version",
- "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
- "type": "commit",
- "tagger": {
- "name": "Monalisa Octocat",
- "email": "octocat@github.com",
- "date": "2011-06-17T14:53:35-07:00"
+ "examples": {
+ "default": {
+ "value": {
+ "tag": "v0.0.1",
+ "message": "initial version",
+ "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
+ "type": "commit",
+ "tagger": {
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com",
+ "date": "2011-06-17T14:53:35-07:00"
+ }
+ }
}
}
}
@@ -40082,16 +40202,20 @@
"tree"
]
},
- "example": {
- "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
- "tree": [
- {
- "path": "file.rb",
- "mode": "100644",
- "type": "blob",
- "sha": "44b4fc6d56897b048c772eb4087f854f46256132"
+ "examples": {
+ "default": {
+ "value": {
+ "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
+ "tree": [
+ {
+ "path": "file.rb",
+ "mode": "100644",
+ "type": "blob",
+ "sha": "44b4fc6d56897b048c772eb4087f854f46256132"
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -41174,16 +41298,20 @@
"title"
]
},
- "example": {
- "title": "Found a bug",
- "body": "I'm having a problem with this.",
- "assignees": [
- "octocat"
- ],
- "milestone": 1,
- "labels": [
- "bug"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Found a bug",
+ "body": "I'm having a problem with this.",
+ "assignees": [
+ "octocat"
+ ],
+ "milestone": 1,
+ "labels": [
+ "bug"
+ ]
+ }
+ }
}
}
}
@@ -42375,11 +42503,15 @@
}
}
},
- "example": {
- "assignees": [
- "hubot",
- "other_user"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "assignees": [
+ "hubot",
+ "other_user"
+ ]
+ }
+ }
}
}
}
@@ -42481,11 +42613,15 @@
}
}
},
- "example": {
- "assignees": [
- "hubot",
- "other_user"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "assignees": [
+ "hubot",
+ "other_user"
+ ]
+ }
+ }
}
}
}
@@ -42783,8 +42919,12 @@
"body"
]
},
- "example": {
- "body": "Me too"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Me too"
+ }
+ }
}
}
}
@@ -43057,8 +43197,12 @@
"body"
]
},
- "example": {
- "body": "Me too"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Me too"
+ }
+ }
}
}
}
@@ -43568,11 +43712,15 @@
}
]
},
- "example": {
- "labels": [
- "bug",
- "enhancement"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "labels": [
+ "bug",
+ "enhancement"
+ ]
+ }
+ }
}
}
}
@@ -43736,11 +43884,15 @@
}
]
},
- "example": {
- "labels": [
- "bug",
- "enhancement"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "labels": [
+ "bug",
+ "enhancement"
+ ]
+ }
+ }
}
}
}
@@ -44092,10 +44244,14 @@
"name"
]
},
- "example": {
- "name": "bug",
- "description": "Something isn't working",
- "color": "f29513"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513"
+ }
+ }
}
}
}
@@ -44305,10 +44461,14 @@
}
}
},
- "example": {
- "new_name": "bug :bug:",
- "description": "Small bug fix required",
- "color": "b01f26"
+ "examples": {
+ "default": {
+ "value": {
+ "new_name": "bug :bug:",
+ "description": "Small bug fix required",
+ "color": "b01f26"
+ }
+ }
}
}
}
@@ -44722,11 +44882,15 @@
"title"
]
},
- "example": {
- "title": "v1.0",
- "state": "open",
- "description": "Tracking milestone for version 1.0",
- "due_on": "2012-10-09T23:39:01Z"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "v1.0",
+ "state": "open",
+ "description": "Tracking milestone for version 1.0",
+ "due_on": "2012-10-09T23:39:01Z"
+ }
+ }
}
}
}
@@ -44968,11 +45132,15 @@
}
}
},
- "example": {
- "title": "v1.0",
- "state": "open",
- "description": "Tracking milestone for version 1.0",
- "due_on": "2012-10-09T23:39:01Z"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "v1.0",
+ "state": "open",
+ "description": "Tracking milestone for version 1.0",
+ "due_on": "2012-10-09T23:39:01Z"
+ }
+ }
}
}
}
@@ -47619,17 +47787,21 @@
}
}
},
- "example": {
- "billing_email": "mona@github.com",
- "company": "GitHub",
- "email": "mona@github.com",
- "twitter_username": "github",
- "location": "San Francisco",
- "name": "github",
- "description": "GitHub, the company.",
- "default_repository_permission": "read",
- "members_can_create_repositories": true,
- "members_allowed_repository_creation_type": "all"
+ "examples": {
+ "default": {
+ "value": {
+ "billing_email": "mona@github.com",
+ "company": "GitHub",
+ "email": "mona@github.com",
+ "twitter_username": "github",
+ "location": "San Francisco",
+ "name": "github",
+ "description": "GitHub, the company.",
+ "default_repository_permission": "read",
+ "members_can_create_repositories": true,
+ "members_allowed_repository_creation_type": "all"
+ }
+ }
}
}
}
@@ -49033,8 +49205,12 @@
"state"
]
},
- "example": {
- "state": "active"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "active"
+ }
+ }
}
}
}
@@ -49618,16 +49794,20 @@
"config"
]
},
- "example": {
- "name": "web",
- "active": true,
- "events": [
- "push",
- "pull_request"
- ],
- "config": {
- "url": "http://example.com/webhook",
- "content_type": "json"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "url": "http://example.com/webhook",
+ "content_type": "json"
+ }
+ }
}
}
}
@@ -50148,11 +50328,15 @@
}
}
},
- "example": {
- "active": true,
- "events": [
- "pull_request"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "active": true,
+ "events": [
+ "pull_request"
+ ]
+ }
+ }
}
}
}
@@ -51930,9 +52114,13 @@
"name"
]
},
- "example": {
- "name": "Organization Roadmap",
- "body": "High-level roadmap for the upcoming year."
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Organization Roadmap",
+ "body": "High-level roadmap for the upcoming year."
+ }
+ }
}
}
}
@@ -52523,9 +52711,13 @@
"name"
]
},
- "example": {
- "name": "Projects Documentation",
- "body": "Developer documentation project for the developer site."
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Projects Documentation",
+ "body": "Developer documentation project for the developer site."
+ }
+ }
}
}
}
@@ -54699,11 +54891,15 @@
"base"
]
},
- "example": {
- "title": "Amazing new feature",
- "body": "Please pull these awesome changes in!",
- "head": "octocat:new-feature",
- "base": "master"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Amazing new feature",
+ "body": "Please pull these awesome changes in!",
+ "head": "octocat:new-feature",
+ "base": "master"
+ }
+ }
}
}
}
@@ -54984,11 +55180,15 @@
}
}
},
- "example": {
- "title": "new title",
- "body": "updated body",
- "state": "open",
- "base": "master"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "new title",
+ "body": "updated body",
+ "state": "open",
+ "base": "master"
+ }
+ }
}
}
}
@@ -55864,8 +56064,12 @@
"body"
]
},
- "example": {
- "body": "I like this too!"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "I like this too!"
+ }
+ }
}
}
}
@@ -56455,8 +56659,12 @@
"body"
]
},
- "example": {
- "body": "Great stuff!"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Great stuff!"
+ }
+ }
}
}
}
@@ -56670,15 +56878,19 @@
}
]
},
- "example": {
- "reviewers": [
- "octocat",
- "hubot",
- "other_user"
- ],
- "team_reviewers": [
- "justice-league"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "reviewers": [
+ "octocat",
+ "hubot",
+ "other_user"
+ ],
+ "team_reviewers": [
+ "justice-league"
+ ]
+ }
+ }
}
}
}
@@ -57217,17 +57429,21 @@
}
}
},
- "example": {
- "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
- "body": "This is close to perfect! Please address the suggested inline change.",
- "event": "REQUEST_CHANGES",
- "comments": [
- {
- "path": "file.md",
- "position": 6,
- "body": "Please add more information here, and fix this typo."
+ "examples": {
+ "default": {
+ "value": {
+ "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
+ "body": "This is close to perfect! Please address the suggested inline change.",
+ "event": "REQUEST_CHANGES",
+ "comments": [
+ {
+ "path": "file.md",
+ "position": 6,
+ "body": "Please add more information here, and fix this typo."
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -59072,7 +59288,7 @@
"content"
]
},
- "example": {
+ "examples": {
"default": {
"value": {
"content": "heart"
@@ -60662,8 +60878,12 @@
"content"
]
},
- "example": {
- "content": "heart"
+ "examples": {
+ "default": {
+ "value": {
+ "content": "heart"
+ }
+ }
}
}
}
@@ -60873,8 +61093,12 @@
"content"
]
},
- "example": {
- "content": "heart"
+ "examples": {
+ "default": {
+ "value": {
+ "content": "heart"
+ }
+ }
}
}
}
@@ -61117,14 +61341,18 @@
"tag_name"
]
},
- "example": {
- "tag_name": "v1.0.0",
- "target_commitish": "master",
- "name": "v1.0.0",
- "body": "Description of the release",
- "draft": false,
- "prerelease": false,
- "generate_release_notes": false
+ "examples": {
+ "default": {
+ "value": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "master",
+ "name": "v1.0.0",
+ "body": "Description of the release",
+ "draft": false,
+ "prerelease": false,
+ "generate_release_notes": false
+ }
+ }
}
}
}
@@ -61304,11 +61532,15 @@
"tag_name"
]
},
- "example": {
- "tag_name": "v1.0.0",
- "target_commitish": "main",
- "previous_tag_name": "v0.9.2",
- "configuration_file_path": ".github/custom_release_config.yml"
+ "examples": {
+ "default": {
+ "value": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "main",
+ "previous_tag_name": "v0.9.2",
+ "configuration_file_path": ".github/custom_release_config.yml"
+ }
+ }
}
}
}
@@ -61675,13 +61907,17 @@
}
}
},
- "example": {
- "tag_name": "v1.0.0",
- "target_commitish": "master",
- "name": "v1.0.0",
- "body": "Description of the release",
- "draft": false,
- "prerelease": false
+ "examples": {
+ "default": {
+ "value": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "master",
+ "name": "v1.0.0",
+ "body": "Description of the release",
+ "draft": false,
+ "prerelease": false
+ }
+ }
}
}
}
@@ -61987,9 +62223,13 @@
}
}
},
- "example": {
- "name": "foo-1.0.0-osx.zip",
- "label": "Mac binary"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "foo-1.0.0-osx.zip",
+ "label": "Mac binary"
+ }
+ }
}
}
}
@@ -62633,14 +62873,18 @@
"name"
]
},
- "example": {
- "name": "Hello-World",
- "description": "This is your first repository",
- "homepage": "https://github.com",
- "private": false,
- "has_issues": true,
- "has_projects": true,
- "has_wiki": true
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Hello-World",
+ "description": "This is your first repository",
+ "homepage": "https://github.com",
+ "private": false,
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true
+ }
+ }
}
}
}
@@ -64079,13 +64323,17 @@
"names"
]
},
- "example": {
- "names": [
- "octocat",
- "atom",
- "electron",
- "api"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "names": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ]
+ }
+ }
}
}
}
@@ -64200,12 +64448,16 @@
"new_owner"
]
},
- "example": {
- "new_owner": "github",
- "team_ids": [
- 12,
- 345
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "new_owner": "github",
+ "team_ids": [
+ 12,
+ 345
+ ]
+ }
+ }
}
}
}
@@ -64345,12 +64597,16 @@
"name"
]
},
- "example": {
- "owner": "octocat",
- "name": "Hello-World",
- "description": "This is your first repository",
- "include_all_branches": false,
- "private": false
+ "examples": {
+ "default": {
+ "value": {
+ "owner": "octocat",
+ "name": "Hello-World",
+ "description": "This is your first repository",
+ "include_all_branches": false,
+ "private": false
+ }
+ }
}
}
}
@@ -65426,9 +65682,13 @@
"url_template"
]
},
- "example": {
- "key_prefix": "TICKET-",
- "url_template": "https://example.com/TICKET?query="
+ "examples": {
+ "default": {
+ "value": {
+ "key_prefix": "TICKET-",
+ "url_template": "https://example.com/TICKET?query="
+ }
+ }
}
}
}
@@ -66443,13 +66703,17 @@
"sha"
]
},
- "example": {
- "message": "my commit message",
- "committer": {
- "name": "Monalisa Octocat",
- "email": "octocat@github.com"
- },
- "sha": "329688480d39049927147c162b9d2deaf885005f"
+ "examples": {
+ "default": {
+ "value": {
+ "message": "my commit message",
+ "committer": {
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com"
+ },
+ "sha": "329688480d39049927147c162b9d2deaf885005f"
+ }
+ }
}
}
}
@@ -68397,9 +68661,13 @@
"state"
]
},
- "example": {
- "state": "resolved",
- "resolution": "false_positive"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "resolved",
+ "resolution": "false_positive"
+ }
+ }
}
}
}
@@ -68765,11 +69033,15 @@
"name"
]
},
- "example": {
- "name": "Justice League",
- "description": "A great team",
- "permission": "push",
- "privacy": "closed"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Justice League",
+ "description": "A great team",
+ "permission": "push",
+ "privacy": "closed"
+ }
+ }
}
}
}
@@ -69054,10 +69326,14 @@
}
}
},
- "example": {
- "name": "new team name",
- "description": "new team description",
- "privacy": "closed"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "new team name",
+ "description": "new team description",
+ "privacy": "closed"
+ }
+ }
}
}
}
@@ -71228,8 +71504,12 @@
"body"
]
},
- "example": {
- "body": "Do you like apples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like apples?"
+ }
+ }
}
}
}
@@ -71412,8 +71692,12 @@
"body"
]
},
- "example": {
- "body": "Do you like pineapples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like pineapples?"
+ }
+ }
}
}
}
@@ -71667,8 +71951,12 @@
"body"
]
},
- "example": {
- "body": "Do you like apples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like apples?"
+ }
+ }
}
}
}
@@ -71837,8 +72125,12 @@
"body"
]
},
- "example": {
- "body": "Do you like pineapples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like pineapples?"
+ }
+ }
}
}
}
@@ -72119,9 +72411,13 @@
"body"
]
},
- "example": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Our first team post",
+ "body": "Hi! This is an area for us to collaborate as a team."
+ }
+ }
}
}
}
@@ -72311,8 +72607,12 @@
}
}
},
- "example": {
- "title": "Welcome to our first team post"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Welcome to our first team post"
+ }
+ }
}
}
}
@@ -72568,9 +72868,13 @@
"body"
]
},
- "example": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Our first team post",
+ "body": "Hi! This is an area for us to collaborate as a team."
+ }
+ }
}
}
}
@@ -72746,8 +73050,12 @@
}
}
},
- "example": {
- "title": "Welcome to our first team post"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Welcome to our first team post"
+ }
+ }
}
}
}
@@ -76795,17 +77103,21 @@
},
"additionalProperties": false
},
- "example": {
- "name": "web",
- "active": true,
- "events": [
- "push",
- "pull_request"
- ],
- "config": {
- "url": "https://example.com/webhook",
- "content_type": "json",
- "insecure_ssl": "0"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "url": "https://example.com/webhook",
+ "content_type": "json",
+ "insecure_ssl": "0"
+ }
+ }
}
}
}
@@ -77403,11 +77715,15 @@
}
}
},
- "example": {
- "active": true,
- "add_events": [
- "pull_request"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "active": true,
+ "add_events": [
+ "pull_request"
+ ]
+ }
+ }
}
}
}
diff --git a/lib/rest/static/decorated/ghes-3.4.json b/lib/rest/static/decorated/ghes-3.4.json
index b9b7448ae47b..8df01ee305ff 100644
--- a/lib/rest/static/decorated/ghes-3.4.json
+++ b/lib/rest/static/decorated/ghes-3.4.json
@@ -1590,7 +1590,7 @@
"subcategory": "permissions",
"notes": [],
"bodyParameters": [],
- "descriptionHTML": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint. GitHub Apps must have the administration repository permission to use this API.
",
+ "descriptionHTML": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.
\nYou must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.
",
"responses": [
{
"httpStatusCode": "200",
@@ -3531,17 +3531,21 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected",
- "selected_organization_ids": [
- 32,
- 91
- ],
- "runners": [
- 9,
- 2
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected",
+ "selected_organization_ids": [
+ 32,
+ 91
+ ],
+ "runners": [
+ 9,
+ 2
+ ]
+ }
+ }
}
}
}
@@ -3759,9 +3763,13 @@
}
}
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected"
+ }
+ }
}
}
}
@@ -4655,17 +4663,21 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected",
- "selected_repository_ids": [
- 32,
- 91
- ],
- "runners": [
- 9,
- 2
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected",
+ "selected_repository_ids": [
+ 32,
+ 91
+ ],
+ "runners": [
+ 9,
+ 2
+ ]
+ }
+ }
}
}
}
@@ -4886,9 +4898,13 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected"
+ }
+ }
}
}
}
@@ -17705,8 +17721,12 @@
"new_name"
]
},
- "example": {
- "new_name": "my_renamed_branch"
+ "examples": {
+ "default": {
+ "value": {
+ "new_name": "my_renamed_branch"
+ }
+ }
}
}
}
@@ -17811,8 +17831,12 @@
"branch"
]
},
- "example": {
- "branch": "main"
+ "examples": {
+ "default": {
+ "value": {
+ "branch": "main"
+ }
+ }
}
}
}
@@ -19187,26 +19211,30 @@
}
}
},
- "example": {
- "dismissal_restrictions": {
- "users": [
- "octocat"
- ],
- "teams": [
- "justice-league"
- ]
- },
- "bypass_pull_request_allowances": {
- "users": [
- "octocat"
- ],
- "teams": [
- "justice-league"
- ]
- },
- "dismiss_stale_reviews": true,
- "require_code_owner_reviews": true,
- "required_approving_review_count": 2
+ "examples": {
+ "default": {
+ "value": {
+ "dismissal_restrictions": {
+ "users": [
+ "octocat"
+ ],
+ "teams": [
+ "justice-league"
+ ]
+ },
+ "bypass_pull_request_allowances": {
+ "users": [
+ "octocat"
+ ],
+ "teams": [
+ "justice-league"
+ ]
+ },
+ "dismiss_stale_reviews": true,
+ "require_code_owner_reviews": true,
+ "required_approving_review_count": 2
+ }
+ }
}
}
}
@@ -19883,11 +19911,15 @@
}
}
},
- "example": {
- "strict": true,
- "contexts": [
- "continuous-integration/travis-ci"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "strict": true,
+ "contexts": [
+ "continuous-integration/travis-ci"
+ ]
+ }
+ }
}
}
}
@@ -26805,13 +26837,17 @@
}
}
},
- "example": {
- "auto_trigger_checks": [
- {
- "app_id": 4,
- "setting": false
+ "examples": {
+ "default": {
+ "value": {
+ "auto_trigger_checks": [
+ {
+ "app_id": 4,
+ "setting": false
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -27491,9 +27527,13 @@
"state"
]
},
- "example": {
- "state": "dismissed",
- "dismissed_reason": "false positive"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "dismissed",
+ "dismissed_reason": "false positive"
+ }
+ }
}
}
}
@@ -29992,8 +30032,12 @@
"body"
]
},
- "example": {
- "body": "Nice change"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Nice change"
+ }
+ }
}
}
}
@@ -30279,11 +30323,15 @@
"body"
]
},
- "example": {
- "body": "Great stuff",
- "path": "file1.txt",
- "position": 4,
- "line": 1
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Great stuff",
+ "path": "file1.txt",
+ "position": 4,
+ "line": 1
+ }
+ }
}
}
}
@@ -30637,11 +30685,15 @@
"state"
]
},
- "example": {
- "state": "success",
- "target_url": "https://example.com/build/status",
- "description": "The build succeeded!",
- "context": "continuous-integration/jenkins"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "success",
+ "target_url": "https://example.com/build/status",
+ "description": "The build succeeded!",
+ "context": "continuous-integration/jenkins"
+ }
+ }
}
}
}
@@ -31946,10 +31998,14 @@
"key"
]
},
- "example": {
- "title": "octocat@octomac",
- "key": "ssh-rsa AAA...",
- "read_only": true
+ "examples": {
+ "default": {
+ "value": {
+ "title": "octocat@octomac",
+ "key": "ssh-rsa AAA...",
+ "read_only": true
+ }
+ }
}
}
}
@@ -33358,11 +33414,15 @@
"state"
]
},
- "example": {
- "environment": "production",
- "state": "success",
- "log_url": "https://example.com/deployment/42/output",
- "description": "Deployment finished successfully."
+ "examples": {
+ "default": {
+ "value": {
+ "environment": "production",
+ "state": "success",
+ "log_url": "https://example.com/deployment/42/output",
+ "description": "Deployment finished successfully."
+ }
+ }
}
}
}
@@ -34576,16 +34636,20 @@
"config"
]
},
- "example": {
- "name": "web",
- "events": [
- "organization",
- "user"
- ],
- "config": {
- "url": "https://example.com/webhook",
- "content_type": "json",
- "secret": "secret"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "events": [
+ "organization",
+ "user"
+ ],
+ "config": {
+ "url": "https://example.com/webhook",
+ "content_type": "json",
+ "secret": "secret"
+ }
+ }
}
}
}
@@ -34931,12 +34995,16 @@
}
}
},
- "example": {
- "events": [
- "organization"
- ],
- "config": {
- "url": "https://example.com/webhook"
+ "examples": {
+ "default": {
+ "value": {
+ "events": [
+ "organization"
+ ],
+ "config": {
+ "url": "https://example.com/webhook"
+ }
+ }
}
}
}
@@ -35237,8 +35305,12 @@
"ldap_dn"
]
},
- "example": {
- "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
+ "examples": {
+ "default": {
+ "value": {
+ "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
+ }
+ }
}
}
}
@@ -35364,8 +35436,12 @@
"ldap_dn"
]
},
- "example": {
- "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
+ "examples": {
+ "default": {
+ "value": {
+ "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
+ }
+ }
}
}
}
@@ -36327,9 +36403,13 @@
}
}
},
- "example": {
- "enforcement": "enabled",
- "allow_downstream_configuration": false
+ "examples": {
+ "default": {
+ "value": {
+ "enforcement": "enabled",
+ "allow_downstream_configuration": false
+ }
+ }
}
}
}
@@ -36485,10 +36565,14 @@
"admin"
]
},
- "example": {
- "login": "github",
- "profile_name": "GitHub, Inc.",
- "admin": "monalisaoctocat"
+ "examples": {
+ "default": {
+ "value": {
+ "login": "github",
+ "profile_name": "GitHub, Inc.",
+ "admin": "monalisaoctocat"
+ }
+ }
}
}
}
@@ -36757,9 +36841,13 @@
"image_url"
]
},
- "example": {
- "name": "DevTools Hook Env",
- "image_url": "https://my_file_server/path/to/devtools_env.tar.gz"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "DevTools Hook Env",
+ "image_url": "https://my_file_server/path/to/devtools_env.tar.gz"
+ }
+ }
}
}
}
@@ -37270,16 +37358,20 @@
"environment"
]
},
- "example": {
- "name": "Check Commits",
- "script": "scripts/commit_check.sh",
- "enforcement": "disabled",
- "allow_downstream_configuration": false,
- "script_repository": {
- "full_name": "DevIT/hooks"
- },
- "environment": {
- "id": 2
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Check Commits",
+ "script": "scripts/commit_check.sh",
+ "enforcement": "disabled",
+ "allow_downstream_configuration": false,
+ "script_repository": {
+ "full_name": "DevIT/hooks"
+ },
+ "environment": {
+ "id": 2
+ }
+ }
}
}
}
@@ -37502,12 +37594,16 @@
}
}
},
- "example": {
- "name": "Check Commits",
- "environment": {
- "id": 1
- },
- "allow_downstream_configuration": true
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Check Commits",
+ "environment": {
+ "id": 1
+ },
+ "allow_downstream_configuration": true
+ }
+ }
}
}
}
@@ -37872,8 +37968,12 @@
}
}
},
- "example": {
- "enforcement": "enabled"
+ "examples": {
+ "default": {
+ "value": {
+ "enforcement": "enabled"
+ }
+ }
}
}
}
@@ -38264,9 +38364,13 @@
"login"
]
},
- "example": {
- "login": "monalisa",
- "email": "octocat@github.com"
+ "examples": {
+ "default": {
+ "value": {
+ "login": "monalisa",
+ "email": "octocat@github.com"
+ }
+ }
}
}
}
@@ -40649,9 +40753,13 @@
"content"
]
},
- "example": {
- "content": "Content of the blob",
- "encoding": "utf-8"
+ "examples": {
+ "default": {
+ "value": {
+ "content": "Content of the blob",
+ "encoding": "utf-8"
+ }
+ }
}
}
}
@@ -41579,9 +41687,13 @@
"sha"
]
},
- "example": {
- "ref": "refs/heads/featureA",
- "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd"
+ "examples": {
+ "default": {
+ "value": {
+ "ref": "refs/heads/featureA",
+ "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd"
+ }
+ }
}
}
}
@@ -41717,9 +41829,13 @@
"sha"
]
},
- "example": {
- "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
- "force": true
+ "examples": {
+ "default": {
+ "value": {
+ "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
+ "force": true
+ }
+ }
}
}
}
@@ -42009,15 +42125,19 @@
"type"
]
},
- "example": {
- "tag": "v0.0.1",
- "message": "initial version",
- "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
- "type": "commit",
- "tagger": {
- "name": "Monalisa Octocat",
- "email": "octocat@github.com",
- "date": "2011-06-17T14:53:35-07:00"
+ "examples": {
+ "default": {
+ "value": {
+ "tag": "v0.0.1",
+ "message": "initial version",
+ "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
+ "type": "commit",
+ "tagger": {
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com",
+ "date": "2011-06-17T14:53:35-07:00"
+ }
+ }
}
}
}
@@ -42436,16 +42556,20 @@
"tree"
]
},
- "example": {
- "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
- "tree": [
- {
- "path": "file.rb",
- "mode": "100644",
- "type": "blob",
- "sha": "44b4fc6d56897b048c772eb4087f854f46256132"
+ "examples": {
+ "default": {
+ "value": {
+ "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
+ "tree": [
+ {
+ "path": "file.rb",
+ "mode": "100644",
+ "type": "blob",
+ "sha": "44b4fc6d56897b048c772eb4087f854f46256132"
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -43528,16 +43652,20 @@
"title"
]
},
- "example": {
- "title": "Found a bug",
- "body": "I'm having a problem with this.",
- "assignees": [
- "octocat"
- ],
- "milestone": 1,
- "labels": [
- "bug"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Found a bug",
+ "body": "I'm having a problem with this.",
+ "assignees": [
+ "octocat"
+ ],
+ "milestone": 1,
+ "labels": [
+ "bug"
+ ]
+ }
+ }
}
}
}
@@ -44729,11 +44857,15 @@
}
}
},
- "example": {
- "assignees": [
- "hubot",
- "other_user"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "assignees": [
+ "hubot",
+ "other_user"
+ ]
+ }
+ }
}
}
}
@@ -44835,11 +44967,15 @@
}
}
},
- "example": {
- "assignees": [
- "hubot",
- "other_user"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "assignees": [
+ "hubot",
+ "other_user"
+ ]
+ }
+ }
}
}
}
@@ -45137,8 +45273,12 @@
"body"
]
},
- "example": {
- "body": "Me too"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Me too"
+ }
+ }
}
}
}
@@ -45411,8 +45551,12 @@
"body"
]
},
- "example": {
- "body": "Me too"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Me too"
+ }
+ }
}
}
}
@@ -45922,11 +46066,15 @@
}
]
},
- "example": {
- "labels": [
- "bug",
- "enhancement"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "labels": [
+ "bug",
+ "enhancement"
+ ]
+ }
+ }
}
}
}
@@ -46090,11 +46238,15 @@
}
]
},
- "example": {
- "labels": [
- "bug",
- "enhancement"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "labels": [
+ "bug",
+ "enhancement"
+ ]
+ }
+ }
}
}
}
@@ -46446,10 +46598,14 @@
"name"
]
},
- "example": {
- "name": "bug",
- "description": "Something isn't working",
- "color": "f29513"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513"
+ }
+ }
}
}
}
@@ -46659,10 +46815,14 @@
}
}
},
- "example": {
- "new_name": "bug :bug:",
- "description": "Small bug fix required",
- "color": "b01f26"
+ "examples": {
+ "default": {
+ "value": {
+ "new_name": "bug :bug:",
+ "description": "Small bug fix required",
+ "color": "b01f26"
+ }
+ }
}
}
}
@@ -47076,11 +47236,15 @@
"title"
]
},
- "example": {
- "title": "v1.0",
- "state": "open",
- "description": "Tracking milestone for version 1.0",
- "due_on": "2012-10-09T23:39:01Z"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "v1.0",
+ "state": "open",
+ "description": "Tracking milestone for version 1.0",
+ "due_on": "2012-10-09T23:39:01Z"
+ }
+ }
}
}
}
@@ -47322,11 +47486,15 @@
}
}
},
- "example": {
- "title": "v1.0",
- "state": "open",
- "description": "Tracking milestone for version 1.0",
- "due_on": "2012-10-09T23:39:01Z"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "v1.0",
+ "state": "open",
+ "description": "Tracking milestone for version 1.0",
+ "due_on": "2012-10-09T23:39:01Z"
+ }
+ }
}
}
}
@@ -48599,11 +48767,15 @@
"repositories"
]
},
- "example": {
- "repositories": [
- "github/Hello-World"
- ],
- "lock_repositories": true
+ "examples": {
+ "default": {
+ "value": {
+ "repositories": [
+ "github/Hello-World"
+ ],
+ "lock_repositories": true
+ }
+ }
}
}
}
@@ -50838,17 +51010,21 @@
}
}
},
- "example": {
- "billing_email": "mona@github.com",
- "company": "GitHub",
- "email": "mona@github.com",
- "twitter_username": "github",
- "location": "San Francisco",
- "name": "github",
- "description": "GitHub, the company.",
- "default_repository_permission": "read",
- "members_can_create_repositories": true,
- "members_allowed_repository_creation_type": "all"
+ "examples": {
+ "default": {
+ "value": {
+ "billing_email": "mona@github.com",
+ "company": "GitHub",
+ "email": "mona@github.com",
+ "twitter_username": "github",
+ "location": "San Francisco",
+ "name": "github",
+ "description": "GitHub, the company.",
+ "default_repository_permission": "read",
+ "members_can_create_repositories": true,
+ "members_allowed_repository_creation_type": "all"
+ }
+ }
}
}
}
@@ -52324,8 +52500,12 @@
"state"
]
},
- "example": {
- "state": "active"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "active"
+ }
+ }
}
}
}
@@ -52909,16 +53089,20 @@
"config"
]
},
- "example": {
- "name": "web",
- "active": true,
- "events": [
- "push",
- "pull_request"
- ],
- "config": {
- "url": "http://example.com/webhook",
- "content_type": "json"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "url": "http://example.com/webhook",
+ "content_type": "json"
+ }
+ }
}
}
}
@@ -53439,11 +53623,15 @@
}
}
},
- "example": {
- "active": true,
- "events": [
- "pull_request"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "active": true,
+ "events": [
+ "pull_request"
+ ]
+ }
+ }
}
}
}
@@ -55221,9 +55409,13 @@
"name"
]
},
- "example": {
- "name": "Organization Roadmap",
- "body": "High-level roadmap for the upcoming year."
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Organization Roadmap",
+ "body": "High-level roadmap for the upcoming year."
+ }
+ }
}
}
}
@@ -55814,9 +56006,13 @@
"name"
]
},
- "example": {
- "name": "Projects Documentation",
- "body": "Developer documentation project for the developer site."
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Projects Documentation",
+ "body": "Developer documentation project for the developer site."
+ }
+ }
}
}
}
@@ -57990,11 +58186,15 @@
"base"
]
},
- "example": {
- "title": "Amazing new feature",
- "body": "Please pull these awesome changes in!",
- "head": "octocat:new-feature",
- "base": "master"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Amazing new feature",
+ "body": "Please pull these awesome changes in!",
+ "head": "octocat:new-feature",
+ "base": "master"
+ }
+ }
}
}
}
@@ -58275,11 +58475,15 @@
}
}
},
- "example": {
- "title": "new title",
- "body": "updated body",
- "state": "open",
- "base": "master"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "new title",
+ "body": "updated body",
+ "state": "open",
+ "base": "master"
+ }
+ }
}
}
}
@@ -59155,8 +59359,12 @@
"body"
]
},
- "example": {
- "body": "I like this too!"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "I like this too!"
+ }
+ }
}
}
}
@@ -59746,8 +59954,12 @@
"body"
]
},
- "example": {
- "body": "Great stuff!"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Great stuff!"
+ }
+ }
}
}
}
@@ -59961,15 +60173,19 @@
}
]
},
- "example": {
- "reviewers": [
- "octocat",
- "hubot",
- "other_user"
- ],
- "team_reviewers": [
- "justice-league"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "reviewers": [
+ "octocat",
+ "hubot",
+ "other_user"
+ ],
+ "team_reviewers": [
+ "justice-league"
+ ]
+ }
+ }
}
}
}
@@ -60508,17 +60724,21 @@
}
}
},
- "example": {
- "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
- "body": "This is close to perfect! Please address the suggested inline change.",
- "event": "REQUEST_CHANGES",
- "comments": [
- {
- "path": "file.md",
- "position": 6,
- "body": "Please add more information here, and fix this typo."
+ "examples": {
+ "default": {
+ "value": {
+ "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
+ "body": "This is close to perfect! Please address the suggested inline change.",
+ "event": "REQUEST_CHANGES",
+ "comments": [
+ {
+ "path": "file.md",
+ "position": 6,
+ "body": "Please add more information here, and fix this typo."
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -62363,7 +62583,7 @@
"content"
]
},
- "example": {
+ "examples": {
"default": {
"value": {
"content": "heart"
@@ -63953,8 +64173,12 @@
"content"
]
},
- "example": {
- "content": "heart"
+ "examples": {
+ "default": {
+ "value": {
+ "content": "heart"
+ }
+ }
}
}
}
@@ -64164,8 +64388,12 @@
"content"
]
},
- "example": {
- "content": "heart"
+ "examples": {
+ "default": {
+ "value": {
+ "content": "heart"
+ }
+ }
}
}
}
@@ -64408,14 +64636,18 @@
"tag_name"
]
},
- "example": {
- "tag_name": "v1.0.0",
- "target_commitish": "master",
- "name": "v1.0.0",
- "body": "Description of the release",
- "draft": false,
- "prerelease": false,
- "generate_release_notes": false
+ "examples": {
+ "default": {
+ "value": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "master",
+ "name": "v1.0.0",
+ "body": "Description of the release",
+ "draft": false,
+ "prerelease": false,
+ "generate_release_notes": false
+ }
+ }
}
}
}
@@ -64595,11 +64827,15 @@
"tag_name"
]
},
- "example": {
- "tag_name": "v1.0.0",
- "target_commitish": "main",
- "previous_tag_name": "v0.9.2",
- "configuration_file_path": ".github/custom_release_config.yml"
+ "examples": {
+ "default": {
+ "value": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "main",
+ "previous_tag_name": "v0.9.2",
+ "configuration_file_path": ".github/custom_release_config.yml"
+ }
+ }
}
}
}
@@ -64966,13 +65202,17 @@
}
}
},
- "example": {
- "tag_name": "v1.0.0",
- "target_commitish": "master",
- "name": "v1.0.0",
- "body": "Description of the release",
- "draft": false,
- "prerelease": false
+ "examples": {
+ "default": {
+ "value": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "master",
+ "name": "v1.0.0",
+ "body": "Description of the release",
+ "draft": false,
+ "prerelease": false
+ }
+ }
}
}
}
@@ -65278,9 +65518,13 @@
}
}
},
- "example": {
- "name": "foo-1.0.0-osx.zip",
- "label": "Mac binary"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "foo-1.0.0-osx.zip",
+ "label": "Mac binary"
+ }
+ }
}
}
}
@@ -65924,14 +66168,18 @@
"name"
]
},
- "example": {
- "name": "Hello-World",
- "description": "This is your first repository",
- "homepage": "https://github.com",
- "private": false,
- "has_issues": true,
- "has_projects": true,
- "has_wiki": true
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Hello-World",
+ "description": "This is your first repository",
+ "homepage": "https://github.com",
+ "private": false,
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true
+ }
+ }
}
}
}
@@ -67454,13 +67702,17 @@
"names"
]
},
- "example": {
- "names": [
- "octocat",
- "atom",
- "electron",
- "api"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "names": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ]
+ }
+ }
}
}
}
@@ -67575,12 +67827,16 @@
"new_owner"
]
},
- "example": {
- "new_owner": "github",
- "team_ids": [
- 12,
- 345
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "new_owner": "github",
+ "team_ids": [
+ 12,
+ 345
+ ]
+ }
+ }
}
}
}
@@ -67720,12 +67976,16 @@
"name"
]
},
- "example": {
- "owner": "octocat",
- "name": "Hello-World",
- "description": "This is your first repository",
- "include_all_branches": false,
- "private": false
+ "examples": {
+ "default": {
+ "value": {
+ "owner": "octocat",
+ "name": "Hello-World",
+ "description": "This is your first repository",
+ "include_all_branches": false,
+ "private": false
+ }
+ }
}
}
}
@@ -68801,9 +69061,13 @@
"url_template"
]
},
- "example": {
- "key_prefix": "TICKET-",
- "url_template": "https://example.com/TICKET?query="
+ "examples": {
+ "default": {
+ "value": {
+ "key_prefix": "TICKET-",
+ "url_template": "https://example.com/TICKET?query="
+ }
+ }
}
}
}
@@ -69818,13 +70082,17 @@
"sha"
]
},
- "example": {
- "message": "my commit message",
- "committer": {
- "name": "Monalisa Octocat",
- "email": "octocat@github.com"
- },
- "sha": "329688480d39049927147c162b9d2deaf885005f"
+ "examples": {
+ "default": {
+ "value": {
+ "message": "my commit message",
+ "committer": {
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com"
+ },
+ "sha": "329688480d39049927147c162b9d2deaf885005f"
+ }
+ }
}
}
}
@@ -71892,9 +72160,13 @@
"state"
]
},
- "example": {
- "state": "resolved",
- "resolution": "false_positive"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "resolved",
+ "resolution": "false_positive"
+ }
+ }
}
}
}
@@ -72260,11 +72532,15 @@
"name"
]
},
- "example": {
- "name": "Justice League",
- "description": "A great team",
- "permission": "push",
- "privacy": "closed"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Justice League",
+ "description": "A great team",
+ "permission": "push",
+ "privacy": "closed"
+ }
+ }
}
}
}
@@ -72549,10 +72825,14 @@
}
}
},
- "example": {
- "name": "new team name",
- "description": "new team description",
- "privacy": "closed"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "new team name",
+ "description": "new team description",
+ "privacy": "closed"
+ }
+ }
}
}
}
@@ -74723,8 +75003,12 @@
"body"
]
},
- "example": {
- "body": "Do you like apples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like apples?"
+ }
+ }
}
}
}
@@ -74907,8 +75191,12 @@
"body"
]
},
- "example": {
- "body": "Do you like pineapples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like pineapples?"
+ }
+ }
}
}
}
@@ -75162,8 +75450,12 @@
"body"
]
},
- "example": {
- "body": "Do you like apples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like apples?"
+ }
+ }
}
}
}
@@ -75332,8 +75624,12 @@
"body"
]
},
- "example": {
- "body": "Do you like pineapples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like pineapples?"
+ }
+ }
}
}
}
@@ -75614,9 +75910,13 @@
"body"
]
},
- "example": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Our first team post",
+ "body": "Hi! This is an area for us to collaborate as a team."
+ }
+ }
}
}
}
@@ -75806,8 +76106,12 @@
}
}
},
- "example": {
- "title": "Welcome to our first team post"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Welcome to our first team post"
+ }
+ }
}
}
}
@@ -76063,9 +76367,13 @@
"body"
]
},
- "example": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Our first team post",
+ "body": "Hi! This is an area for us to collaborate as a team."
+ }
+ }
}
}
}
@@ -76241,8 +76549,12 @@
}
}
},
- "example": {
- "title": "Welcome to our first team post"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Welcome to our first team post"
+ }
+ }
}
}
}
@@ -80290,17 +80602,21 @@
},
"additionalProperties": false
},
- "example": {
- "name": "web",
- "active": true,
- "events": [
- "push",
- "pull_request"
- ],
- "config": {
- "url": "https://example.com/webhook",
- "content_type": "json",
- "insecure_ssl": "0"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "url": "https://example.com/webhook",
+ "content_type": "json",
+ "insecure_ssl": "0"
+ }
+ }
}
}
}
@@ -80898,11 +81214,15 @@
}
}
},
- "example": {
- "active": true,
- "add_events": [
- "pull_request"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "active": true,
+ "add_events": [
+ "pull_request"
+ ]
+ }
+ }
}
}
}
diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json
index fba4aa8b7076..6cfad58c1d3b 100644
--- a/lib/rest/static/decorated/github.ae.json
+++ b/lib/rest/static/decorated/github.ae.json
@@ -3186,17 +3186,21 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected",
- "selected_organization_ids": [
- 32,
- 91
- ],
- "runners": [
- 9,
- 2
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected",
+ "selected_organization_ids": [
+ 32,
+ 91
+ ],
+ "runners": [
+ 9,
+ 2
+ ]
+ }
+ }
}
}
}
@@ -3414,9 +3418,13 @@
}
}
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected"
+ }
+ }
}
}
}
@@ -4001,17 +4009,21 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected",
- "selected_repository_ids": [
- 32,
- 91
- ],
- "runners": [
- 9,
- 2
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected",
+ "selected_repository_ids": [
+ 32,
+ 91
+ ],
+ "runners": [
+ 9,
+ 2
+ ]
+ }
+ }
}
}
}
@@ -4232,9 +4244,13 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected"
+ }
+ }
}
}
}
@@ -12980,8 +12996,12 @@
"branch"
]
},
- "example": {
- "branch": "main"
+ "examples": {
+ "default": {
+ "value": {
+ "branch": "main"
+ }
+ }
}
}
}
@@ -14356,26 +14376,30 @@
}
}
},
- "example": {
- "dismissal_restrictions": {
- "users": [
- "octocat"
- ],
- "teams": [
- "justice-league"
- ]
- },
- "bypass_pull_request_allowances": {
- "users": [
- "octocat"
- ],
- "teams": [
- "justice-league"
- ]
- },
- "dismiss_stale_reviews": true,
- "require_code_owner_reviews": true,
- "required_approving_review_count": 2
+ "examples": {
+ "default": {
+ "value": {
+ "dismissal_restrictions": {
+ "users": [
+ "octocat"
+ ],
+ "teams": [
+ "justice-league"
+ ]
+ },
+ "bypass_pull_request_allowances": {
+ "users": [
+ "octocat"
+ ],
+ "teams": [
+ "justice-league"
+ ]
+ },
+ "dismiss_stale_reviews": true,
+ "require_code_owner_reviews": true,
+ "required_approving_review_count": 2
+ }
+ }
}
}
}
@@ -15052,11 +15076,15 @@
}
}
},
- "example": {
- "strict": true,
- "contexts": [
- "continuous-integration/travis-ci"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "strict": true,
+ "contexts": [
+ "continuous-integration/travis-ci"
+ ]
+ }
+ }
}
}
}
@@ -21974,13 +22002,17 @@
}
}
},
- "example": {
- "auto_trigger_checks": [
- {
- "app_id": 4,
- "setting": false
+ "examples": {
+ "default": {
+ "value": {
+ "auto_trigger_checks": [
+ {
+ "app_id": 4,
+ "setting": false
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -22619,9 +22651,13 @@
"state"
]
},
- "example": {
- "state": "dismissed",
- "dismissed_reason": "false positive"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "dismissed",
+ "dismissed_reason": "false positive"
+ }
+ }
}
}
}
@@ -25120,8 +25156,12 @@
"body"
]
},
- "example": {
- "body": "Nice change"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Nice change"
+ }
+ }
}
}
}
@@ -25407,11 +25447,15 @@
"body"
]
},
- "example": {
- "body": "Great stuff",
- "path": "file1.txt",
- "position": 4,
- "line": 1
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Great stuff",
+ "path": "file1.txt",
+ "position": 4,
+ "line": 1
+ }
+ }
}
}
}
@@ -25765,11 +25809,15 @@
"state"
]
},
- "example": {
- "state": "success",
- "target_url": "https://example.com/build/status",
- "description": "The build succeeded!",
- "context": "continuous-integration/jenkins"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "success",
+ "target_url": "https://example.com/build/status",
+ "description": "The build succeeded!",
+ "context": "continuous-integration/jenkins"
+ }
+ }
}
}
}
@@ -25989,10 +26037,14 @@
"key"
]
},
- "example": {
- "title": "octocat@octomac",
- "key": "ssh-rsa AAA...",
- "read_only": true
+ "examples": {
+ "default": {
+ "value": {
+ "title": "octocat@octomac",
+ "key": "ssh-rsa AAA...",
+ "read_only": true
+ }
+ }
}
}
}
@@ -27401,11 +27453,15 @@
"state"
]
},
- "example": {
- "environment": "production",
- "state": "success",
- "log_url": "https://example.com/deployment/42/output",
- "description": "Deployment finished successfully."
+ "examples": {
+ "default": {
+ "value": {
+ "environment": "production",
+ "state": "success",
+ "log_url": "https://example.com/deployment/42/output",
+ "description": "Deployment finished successfully."
+ }
+ }
}
}
}
@@ -28419,16 +28475,20 @@
"config"
]
},
- "example": {
- "name": "web",
- "events": [
- "organization",
- "user"
- ],
- "config": {
- "url": "https://example.com/webhook",
- "content_type": "json",
- "secret": "secret"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "events": [
+ "organization",
+ "user"
+ ],
+ "config": {
+ "url": "https://example.com/webhook",
+ "content_type": "json",
+ "secret": "secret"
+ }
+ }
}
}
}
@@ -28774,12 +28834,16 @@
}
}
},
- "example": {
- "events": [
- "organization"
- ],
- "config": {
- "url": "https://example.com/webhook"
+ "examples": {
+ "default": {
+ "value": {
+ "events": [
+ "organization"
+ ],
+ "config": {
+ "url": "https://example.com/webhook"
+ }
+ }
}
}
}
@@ -29126,10 +29190,14 @@
"admin"
]
},
- "example": {
- "login": "github",
- "profile_name": "GitHub, Inc.",
- "admin": "monalisaoctocat"
+ "examples": {
+ "default": {
+ "value": {
+ "login": "github",
+ "profile_name": "GitHub, Inc.",
+ "admin": "monalisaoctocat"
+ }
+ }
}
}
}
@@ -29398,9 +29466,13 @@
"image_url"
]
},
- "example": {
- "name": "DevTools Hook Env",
- "image_url": "https://my_file_server/path/to/devtools_env.tar.gz"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "DevTools Hook Env",
+ "image_url": "https://my_file_server/path/to/devtools_env.tar.gz"
+ }
+ }
}
}
}
@@ -29924,19 +29996,23 @@
"displayName"
]
},
- "example": {
- "schemas": [
- "urn:ietf:params:scim:schemas:core:2.0:Group"
- ],
- "displayName": "octo-org",
- "members": [
- {
- "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc"
- },
- {
- "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5"
+ "examples": {
+ "default": {
+ "value": {
+ "schemas": [
+ "urn:ietf:params:scim:schemas:core:2.0:Group"
+ ],
+ "displayName": "octo-org",
+ "members": [
+ {
+ "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc"
+ },
+ {
+ "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5"
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -30203,19 +30279,23 @@
"displayName"
]
},
- "example": {
- "schemas": [
- "urn:ietf:params:scim:schemas:core:2.0:Group"
- ],
- "displayName": "octo-org",
- "members": [
- {
- "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc"
- },
- {
- "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5"
+ "examples": {
+ "default": {
+ "value": {
+ "schemas": [
+ "urn:ietf:params:scim:schemas:core:2.0:Group"
+ ],
+ "displayName": "octo-org",
+ "members": [
+ {
+ "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc"
+ },
+ {
+ "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5"
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -30455,21 +30535,25 @@
"Operations"
]
},
- "example": {
- "schemas": [
- "urn:ietf:params:scim:api:messages:2.0:PatchOp"
- ],
- "Operations": [
- {
- "op": "remove",
- "path": "members",
- "value": [
+ "examples": {
+ "default": {
+ "value": {
+ "schemas": [
+ "urn:ietf:params:scim:api:messages:2.0:PatchOp"
+ ],
+ "Operations": [
{
- "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5"
+ "op": "remove",
+ "path": "members",
+ "value": [
+ {
+ "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5"
+ }
+ ]
}
]
}
- ]
+ }
}
}
}
@@ -33063,9 +33147,13 @@
"content"
]
},
- "example": {
- "content": "Content of the blob",
- "encoding": "utf-8"
+ "examples": {
+ "default": {
+ "value": {
+ "content": "Content of the blob",
+ "encoding": "utf-8"
+ }
+ }
}
}
}
@@ -33993,9 +34081,13 @@
"sha"
]
},
- "example": {
- "ref": "refs/heads/featureA",
- "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd"
+ "examples": {
+ "default": {
+ "value": {
+ "ref": "refs/heads/featureA",
+ "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd"
+ }
+ }
}
}
}
@@ -34131,9 +34223,13 @@
"sha"
]
},
- "example": {
- "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
- "force": true
+ "examples": {
+ "default": {
+ "value": {
+ "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
+ "force": true
+ }
+ }
}
}
}
@@ -34423,15 +34519,19 @@
"type"
]
},
- "example": {
- "tag": "v0.0.1",
- "message": "initial version",
- "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
- "type": "commit",
- "tagger": {
- "name": "Monalisa Octocat",
- "email": "octocat@github.com",
- "date": "2011-06-17T14:53:35-07:00"
+ "examples": {
+ "default": {
+ "value": {
+ "tag": "v0.0.1",
+ "message": "initial version",
+ "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
+ "type": "commit",
+ "tagger": {
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com",
+ "date": "2011-06-17T14:53:35-07:00"
+ }
+ }
}
}
}
@@ -34850,16 +34950,20 @@
"tree"
]
},
- "example": {
- "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
- "tree": [
- {
- "path": "file.rb",
- "mode": "100644",
- "type": "blob",
- "sha": "44b4fc6d56897b048c772eb4087f854f46256132"
+ "examples": {
+ "default": {
+ "value": {
+ "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
+ "tree": [
+ {
+ "path": "file.rb",
+ "mode": "100644",
+ "type": "blob",
+ "sha": "44b4fc6d56897b048c772eb4087f854f46256132"
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -35942,16 +36046,20 @@
"title"
]
},
- "example": {
- "title": "Found a bug",
- "body": "I'm having a problem with this.",
- "assignees": [
- "octocat"
- ],
- "milestone": 1,
- "labels": [
- "bug"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Found a bug",
+ "body": "I'm having a problem with this.",
+ "assignees": [
+ "octocat"
+ ],
+ "milestone": 1,
+ "labels": [
+ "bug"
+ ]
+ }
+ }
}
}
}
@@ -37143,11 +37251,15 @@
}
}
},
- "example": {
- "assignees": [
- "hubot",
- "other_user"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "assignees": [
+ "hubot",
+ "other_user"
+ ]
+ }
+ }
}
}
}
@@ -37249,11 +37361,15 @@
}
}
},
- "example": {
- "assignees": [
- "hubot",
- "other_user"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "assignees": [
+ "hubot",
+ "other_user"
+ ]
+ }
+ }
}
}
}
@@ -37551,8 +37667,12 @@
"body"
]
},
- "example": {
- "body": "Me too"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Me too"
+ }
+ }
}
}
}
@@ -37825,8 +37945,12 @@
"body"
]
},
- "example": {
- "body": "Me too"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Me too"
+ }
+ }
}
}
}
@@ -38336,11 +38460,15 @@
}
]
},
- "example": {
- "labels": [
- "bug",
- "enhancement"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "labels": [
+ "bug",
+ "enhancement"
+ ]
+ }
+ }
}
}
}
@@ -38504,11 +38632,15 @@
}
]
},
- "example": {
- "labels": [
- "bug",
- "enhancement"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "labels": [
+ "bug",
+ "enhancement"
+ ]
+ }
+ }
}
}
}
@@ -38860,10 +38992,14 @@
"name"
]
},
- "example": {
- "name": "bug",
- "description": "Something isn't working",
- "color": "f29513"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513"
+ }
+ }
}
}
}
@@ -39073,10 +39209,14 @@
}
}
},
- "example": {
- "new_name": "bug :bug:",
- "description": "Small bug fix required",
- "color": "b01f26"
+ "examples": {
+ "default": {
+ "value": {
+ "new_name": "bug :bug:",
+ "description": "Small bug fix required",
+ "color": "b01f26"
+ }
+ }
}
}
}
@@ -39490,11 +39630,15 @@
"title"
]
},
- "example": {
- "title": "v1.0",
- "state": "open",
- "description": "Tracking milestone for version 1.0",
- "due_on": "2012-10-09T23:39:01Z"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "v1.0",
+ "state": "open",
+ "description": "Tracking milestone for version 1.0",
+ "due_on": "2012-10-09T23:39:01Z"
+ }
+ }
}
}
}
@@ -39736,11 +39880,15 @@
}
}
},
- "example": {
- "title": "v1.0",
- "state": "open",
- "description": "Tracking milestone for version 1.0",
- "due_on": "2012-10-09T23:39:01Z"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "v1.0",
+ "state": "open",
+ "description": "Tracking milestone for version 1.0",
+ "due_on": "2012-10-09T23:39:01Z"
+ }
+ }
}
}
}
@@ -41013,11 +41161,15 @@
"repositories"
]
},
- "example": {
- "repositories": [
- "github/Hello-World"
- ],
- "lock_repositories": true
+ "examples": {
+ "default": {
+ "value": {
+ "repositories": [
+ "github/Hello-World"
+ ],
+ "lock_repositories": true
+ }
+ }
}
}
}
@@ -42013,17 +42165,21 @@
}
}
},
- "example": {
- "billing_email": "mona@github.com",
- "company": "GitHub",
- "email": "mona@github.com",
- "twitter_username": "github",
- "location": "San Francisco",
- "name": "github",
- "description": "GitHub, the company.",
- "default_repository_permission": "read",
- "members_can_create_repositories": true,
- "members_allowed_repository_creation_type": "all"
+ "examples": {
+ "default": {
+ "value": {
+ "billing_email": "mona@github.com",
+ "company": "GitHub",
+ "email": "mona@github.com",
+ "twitter_username": "github",
+ "location": "San Francisco",
+ "name": "github",
+ "description": "GitHub, the company.",
+ "default_repository_permission": "read",
+ "members_can_create_repositories": true,
+ "members_allowed_repository_creation_type": "all"
+ }
+ }
}
}
}
@@ -43114,8 +43270,12 @@
"state"
]
},
- "example": {
- "state": "active"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "active"
+ }
+ }
}
}
}
@@ -43699,16 +43859,20 @@
"config"
]
},
- "example": {
- "name": "web",
- "active": true,
- "events": [
- "push",
- "pull_request"
- ],
- "config": {
- "url": "http://example.com/webhook",
- "content_type": "json"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "url": "http://example.com/webhook",
+ "content_type": "json"
+ }
+ }
}
}
}
@@ -44229,11 +44393,15 @@
}
}
},
- "example": {
- "active": true,
- "events": [
- "pull_request"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "active": true,
+ "events": [
+ "pull_request"
+ ]
+ }
+ }
}
}
}
@@ -46023,9 +46191,13 @@
"name"
]
},
- "example": {
- "name": "Organization Roadmap",
- "body": "High-level roadmap for the upcoming year."
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Organization Roadmap",
+ "body": "High-level roadmap for the upcoming year."
+ }
+ }
}
}
}
@@ -46616,9 +46788,13 @@
"name"
]
},
- "example": {
- "name": "Projects Documentation",
- "body": "Developer documentation project for the developer site."
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Projects Documentation",
+ "body": "Developer documentation project for the developer site."
+ }
+ }
}
}
}
@@ -48792,11 +48968,15 @@
"base"
]
},
- "example": {
- "title": "Amazing new feature",
- "body": "Please pull these awesome changes in!",
- "head": "octocat:new-feature",
- "base": "master"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Amazing new feature",
+ "body": "Please pull these awesome changes in!",
+ "head": "octocat:new-feature",
+ "base": "master"
+ }
+ }
}
}
}
@@ -49077,11 +49257,15 @@
}
}
},
- "example": {
- "title": "new title",
- "body": "updated body",
- "state": "open",
- "base": "master"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "new title",
+ "body": "updated body",
+ "state": "open",
+ "base": "master"
+ }
+ }
}
}
}
@@ -49957,8 +50141,12 @@
"body"
]
},
- "example": {
- "body": "I like this too!"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "I like this too!"
+ }
+ }
}
}
}
@@ -50548,8 +50736,12 @@
"body"
]
},
- "example": {
- "body": "Great stuff!"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Great stuff!"
+ }
+ }
}
}
}
@@ -50763,15 +50955,19 @@
}
]
},
- "example": {
- "reviewers": [
- "octocat",
- "hubot",
- "other_user"
- ],
- "team_reviewers": [
- "justice-league"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "reviewers": [
+ "octocat",
+ "hubot",
+ "other_user"
+ ],
+ "team_reviewers": [
+ "justice-league"
+ ]
+ }
+ }
}
}
}
@@ -51310,17 +51506,21 @@
}
}
},
- "example": {
- "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
- "body": "This is close to perfect! Please address the suggested inline change.",
- "event": "REQUEST_CHANGES",
- "comments": [
- {
- "path": "file.md",
- "position": 6,
- "body": "Please add more information here, and fix this typo."
+ "examples": {
+ "default": {
+ "value": {
+ "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
+ "body": "This is close to perfect! Please address the suggested inline change.",
+ "event": "REQUEST_CHANGES",
+ "comments": [
+ {
+ "path": "file.md",
+ "position": 6,
+ "body": "Please add more information here, and fix this typo."
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -53133,7 +53333,7 @@
"content"
]
},
- "example": {
+ "examples": {
"default": {
"value": {
"content": "heart"
@@ -54798,13 +54998,17 @@
"tag_name"
]
},
- "example": {
- "tag_name": "v1.0.0",
- "target_commitish": "master",
- "name": "v1.0.0",
- "body": "Description of the release",
- "draft": false,
- "prerelease": false
+ "examples": {
+ "default": {
+ "value": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "master",
+ "name": "v1.0.0",
+ "body": "Description of the release",
+ "draft": false,
+ "prerelease": false
+ }
+ }
}
}
}
@@ -55192,13 +55396,17 @@
}
}
},
- "example": {
- "tag_name": "v1.0.0",
- "target_commitish": "master",
- "name": "v1.0.0",
- "body": "Description of the release",
- "draft": false,
- "prerelease": false
+ "examples": {
+ "default": {
+ "value": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "master",
+ "name": "v1.0.0",
+ "body": "Description of the release",
+ "draft": false,
+ "prerelease": false
+ }
+ }
}
}
}
@@ -55504,9 +55712,13 @@
}
}
},
- "example": {
- "name": "foo-1.0.0-osx.zip",
- "label": "Mac binary"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "foo-1.0.0-osx.zip",
+ "label": "Mac binary"
+ }
+ }
}
}
}
@@ -56150,14 +56362,18 @@
"name"
]
},
- "example": {
- "name": "Hello-World",
- "description": "This is your first repository",
- "homepage": "https://github.com",
- "private": false,
- "has_issues": true,
- "has_projects": true,
- "has_wiki": true
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Hello-World",
+ "description": "This is your first repository",
+ "homepage": "https://github.com",
+ "private": false,
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true
+ }
+ }
}
}
}
@@ -57666,13 +57882,17 @@
"names"
]
},
- "example": {
- "names": [
- "octocat",
- "atom",
- "electron",
- "api"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "names": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ]
+ }
+ }
}
}
}
@@ -57787,12 +58007,16 @@
"new_owner"
]
},
- "example": {
- "new_owner": "github",
- "team_ids": [
- 12,
- 345
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "new_owner": "github",
+ "team_ids": [
+ 12,
+ 345
+ ]
+ }
+ }
}
}
}
@@ -57932,12 +58156,16 @@
"name"
]
},
- "example": {
- "owner": "octocat",
- "name": "Hello-World",
- "description": "This is your first repository",
- "include_all_branches": false,
- "private": false
+ "examples": {
+ "default": {
+ "value": {
+ "owner": "octocat",
+ "name": "Hello-World",
+ "description": "This is your first repository",
+ "include_all_branches": false,
+ "private": false
+ }
+ }
}
}
}
@@ -58934,9 +59162,13 @@
"url_template"
]
},
- "example": {
- "key_prefix": "TICKET-",
- "url_template": "https://example.com/TICKET?query="
+ "examples": {
+ "default": {
+ "value": {
+ "key_prefix": "TICKET-",
+ "url_template": "https://example.com/TICKET?query="
+ }
+ }
}
}
}
@@ -59951,13 +60183,17 @@
"sha"
]
},
- "example": {
- "message": "my commit message",
- "committer": {
- "name": "Monalisa Octocat",
- "email": "octocat@github.com"
- },
- "sha": "329688480d39049927147c162b9d2deaf885005f"
+ "examples": {
+ "default": {
+ "value": {
+ "message": "my commit message",
+ "committer": {
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com"
+ },
+ "sha": "329688480d39049927147c162b9d2deaf885005f"
+ }
+ }
}
}
}
@@ -61796,9 +62032,13 @@
"state"
]
},
- "example": {
- "state": "resolved",
- "resolution": "false_positive"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "resolved",
+ "resolution": "false_positive"
+ }
+ }
}
}
}
@@ -62059,11 +62299,15 @@
"name"
]
},
- "example": {
- "name": "Justice League",
- "description": "A great team",
- "permission": "push",
- "privacy": "closed"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Justice League",
+ "description": "A great team",
+ "permission": "push",
+ "privacy": "closed"
+ }
+ }
}
}
}
@@ -62339,10 +62583,14 @@
}
}
},
- "example": {
- "name": "new team name",
- "description": "new team description",
- "privacy": "closed"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "new team name",
+ "description": "new team description",
+ "privacy": "closed"
+ }
+ }
}
}
}
@@ -64513,8 +64761,12 @@
"body"
]
},
- "example": {
- "body": "Do you like apples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like apples?"
+ }
+ }
}
}
}
@@ -64697,8 +64949,12 @@
"body"
]
},
- "example": {
- "body": "Do you like pineapples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like pineapples?"
+ }
+ }
}
}
}
@@ -64952,8 +65208,12 @@
"body"
]
},
- "example": {
- "body": "Do you like apples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like apples?"
+ }
+ }
}
}
}
@@ -65122,8 +65382,12 @@
"body"
]
},
- "example": {
- "body": "Do you like pineapples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like pineapples?"
+ }
+ }
}
}
}
@@ -65404,9 +65668,13 @@
"body"
]
},
- "example": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Our first team post",
+ "body": "Hi! This is an area for us to collaborate as a team."
+ }
+ }
}
}
}
@@ -65596,8 +65864,12 @@
}
}
},
- "example": {
- "title": "Welcome to our first team post"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Welcome to our first team post"
+ }
+ }
}
}
}
@@ -65853,9 +66125,13 @@
"body"
]
},
- "example": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Our first team post",
+ "body": "Hi! This is an area for us to collaborate as a team."
+ }
+ }
}
}
}
@@ -66031,8 +66307,12 @@
}
}
},
- "example": {
- "title": "Welcome to our first team post"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Welcome to our first team post"
+ }
+ }
}
}
}
@@ -66324,8 +66604,12 @@
"group_id"
]
},
- "example": {
- "group_id": 123
+ "examples": {
+ "default": {
+ "value": {
+ "group_id": 123
+ }
+ }
}
}
}
@@ -69945,17 +70229,21 @@
},
"additionalProperties": false
},
- "example": {
- "name": "web",
- "active": true,
- "events": [
- "push",
- "pull_request"
- ],
- "config": {
- "url": "https://example.com/webhook",
- "content_type": "json",
- "insecure_ssl": "0"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "url": "https://example.com/webhook",
+ "content_type": "json",
+ "insecure_ssl": "0"
+ }
+ }
}
}
}
@@ -70553,11 +70841,15 @@
}
}
},
- "example": {
- "active": true,
- "add_events": [
- "pull_request"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "active": true,
+ "add_events": [
+ "pull_request"
+ ]
+ }
+ }
}
}
}
diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json
index f9660ac3ed9e..8d6a74ef8345 100644
--- a/lib/rest/static/dereferenced/api.github.com.deref.json
+++ b/lib/rest/static/dereferenced/api.github.com.deref.json
@@ -19463,7 +19463,7 @@
"/enterprises/{enterprise}/actions/permissions": {
"get": {
"summary": "Get GitHub Actions permissions for an enterprise",
- "description": "Gets the GitHub Actions permissions policy for organizations and allowed actions and workflows in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
+ "description": "Gets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/get-github-actions-permissions-enterprise",
"tags": [
"enterprise-admin"
@@ -19506,7 +19506,7 @@
},
"allowed_actions": {
"type": "string",
- "description": "The permissions policy that controls the actions and workflows that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.",
+ "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.",
"enum": [
"all",
"local_only",
@@ -19515,7 +19515,7 @@
},
"selected_actions_url": {
"type": "string",
- "description": "The API URL to use to get or set the actions and workflows that are allowed to run, when `allowed_actions` is set to `selected`."
+ "description": "The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`."
}
},
"required": [
@@ -19544,7 +19544,7 @@
},
"put": {
"summary": "Set GitHub Actions permissions for an enterprise",
- "description": "Sets the GitHub Actions permissions policy for organizations and allowed actions and workflows in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
+ "description": "Sets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/set-github-actions-permissions-enterprise",
"tags": [
"enterprise-admin"
@@ -19587,7 +19587,7 @@
},
"allowed_actions": {
"type": "string",
- "description": "The permissions policy that controls the actions and workflows that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.",
+ "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.",
"enum": [
"all",
"local_only",
@@ -19962,8 +19962,8 @@
},
"/enterprises/{enterprise}/actions/permissions/selected-actions": {
"get": {
- "summary": "Get allowed actions and workflows for an enterprise",
- "description": "Gets the selected actions and workflows that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
+ "summary": "Get allowed actions and reusable workflows for an enterprise",
+ "description": "Gets the selected actions and reusable workflows that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/get-allowed-actions-enterprise",
"tags": [
"enterprise-admin"
@@ -20001,7 +20001,7 @@
},
"patterns_allowed": {
"type": "array",
- "description": "Specifies a list of string-matching patterns to allow specific action(s) and workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
+ "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
"items": {
"type": "string"
}
@@ -20032,8 +20032,8 @@
}
},
"put": {
- "summary": "Set allowed actions and workflows for an enterprise",
- "description": "Sets the actions and workflows that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
+ "summary": "Set allowed actions and reusable workflows for an enterprise",
+ "description": "Sets the actions and reusable workflows that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/set-allowed-actions-enterprise",
"tags": [
"enterprise-admin"
@@ -20075,7 +20075,7 @@
},
"patterns_allowed": {
"type": "array",
- "description": "Specifies a list of string-matching patterns to allow specific action(s) and workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
+ "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
"items": {
"type": "string"
}
@@ -20312,17 +20312,21 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected",
- "selected_organization_ids": [
- 32,
- 91
- ],
- "runners": [
- 9,
- 2
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected",
+ "selected_organization_ids": [
+ 32,
+ 91
+ ],
+ "runners": [
+ 9,
+ 2
+ ]
+ }
+ }
}
}
}
@@ -20544,9 +20548,13 @@
}
}
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected"
+ }
+ }
}
}
}
@@ -64391,17 +64399,21 @@
}
}
},
- "example": {
- "billing_email": "mona@github.com",
- "company": "GitHub",
- "email": "mona@github.com",
- "twitter_username": "github",
- "location": "San Francisco",
- "name": "github",
- "description": "GitHub, the company.",
- "default_repository_permission": "read",
- "members_can_create_repositories": true,
- "members_allowed_repository_creation_type": "all"
+ "examples": {
+ "default": {
+ "value": {
+ "billing_email": "mona@github.com",
+ "company": "GitHub",
+ "email": "mona@github.com",
+ "twitter_username": "github",
+ "location": "San Francisco",
+ "name": "github",
+ "description": "GitHub, the company.",
+ "default_repository_permission": "read",
+ "members_can_create_repositories": true,
+ "members_allowed_repository_creation_type": "all"
+ }
+ }
}
}
}
@@ -65180,7 +65192,7 @@
"/orgs/{org}/actions/permissions": {
"get": {
"summary": "Get GitHub Actions permissions for an organization",
- "description": "Gets the GitHub Actions permissions policy for repositories and allowed actions and workflows in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
+ "description": "Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
"operationId": "actions/get-github-actions-permissions-organization",
"tags": [
"actions"
@@ -65222,7 +65234,7 @@
},
"allowed_actions": {
"type": "string",
- "description": "The permissions policy that controls the actions and workflows that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.",
+ "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.",
"enum": [
"all",
"local_only",
@@ -65231,7 +65243,7 @@
},
"selected_actions_url": {
"type": "string",
- "description": "The API URL to use to get or set the actions and workflows that are allowed to run, when `allowed_actions` is set to `selected`."
+ "description": "The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`."
}
},
"required": [
@@ -65260,7 +65272,7 @@
},
"put": {
"summary": "Set GitHub Actions permissions for an organization",
- "description": "Sets the GitHub Actions permissions policy for repositories and allowed actions and workflows in an organization.\n\nIf the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions and workflows, then you cannot override them for the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
+ "description": "Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.\n\nIf the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions and reusable workflows, then you cannot override them for the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
"operationId": "actions/set-github-actions-permissions-organization",
"tags": [
"actions"
@@ -65302,7 +65314,7 @@
},
"allowed_actions": {
"type": "string",
- "description": "The permissions policy that controls the actions and workflows that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.",
+ "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.",
"enum": [
"all",
"local_only",
@@ -67047,8 +67059,8 @@
},
"/orgs/{org}/actions/permissions/selected-actions": {
"get": {
- "summary": "Get allowed actions and workflows for an organization",
- "description": "Gets the selected actions and workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
+ "summary": "Get allowed actions and reusable workflows for an organization",
+ "description": "Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
"operationId": "actions/get-allowed-actions-organization",
"tags": [
"actions"
@@ -67085,7 +67097,7 @@
},
"patterns_allowed": {
"type": "array",
- "description": "Specifies a list of string-matching patterns to allow specific action(s) and workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
+ "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
"items": {
"type": "string"
}
@@ -67116,8 +67128,8 @@
}
},
"put": {
- "summary": "Set allowed actions and workflows for an organization",
- "description": "Sets the actions and workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nIf the organization belongs to an enterprise that has `selected` actions and workflows set at the enterprise level, then you cannot override any of the enterprise's allowed actions and workflows settings.\n\nTo use the `patterns_allowed` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories in the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
+ "summary": "Set allowed actions and reusable workflows for an organization",
+ "description": "Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nIf the organization belongs to an enterprise that has `selected` actions and reusable workflows set at the enterprise level, then you cannot override any of the enterprise's allowed actions and reusable workflows settings.\n\nTo use the `patterns_allowed` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories in the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
"operationId": "actions/set-allowed-actions-organization",
"tags": [
"actions"
@@ -67158,7 +67170,7 @@
},
"patterns_allowed": {
"type": "array",
- "description": "Specifies a list of string-matching patterns to allow specific action(s) and workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
+ "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
"items": {
"type": "string"
}
@@ -67539,17 +67551,21 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected",
- "selected_repository_ids": [
- 32,
- 91
- ],
- "runners": [
- 9,
- 2
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected",
+ "selected_repository_ids": [
+ 32,
+ 91
+ ],
+ "runners": [
+ 9,
+ 2
+ ]
+ }
+ }
}
}
}
@@ -67790,9 +67806,13 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected"
+ }
+ }
}
}
}
@@ -90391,16 +90411,20 @@
"config"
]
},
- "example": {
- "name": "web",
- "active": true,
- "events": [
- "push",
- "pull_request"
- ],
- "config": {
- "url": "http://example.com/webhook",
- "content_type": "json"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "url": "http://example.com/webhook",
+ "content_type": "json"
+ }
+ }
}
}
}
@@ -90982,11 +91006,15 @@
}
}
},
- "example": {
- "active": true,
- "events": [
- "pull_request"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "active": true,
+ "events": [
+ "pull_request"
+ ]
+ }
+ }
}
}
}
@@ -95209,13 +95237,17 @@
}
}
},
- "example": {
- "email": "octocat@github.com",
- "role": "direct_member",
- "team_ids": [
- 12,
- 26
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "email": "octocat@github.com",
+ "role": "direct_member",
+ "team_ids": [
+ 12,
+ 26
+ ]
+ }
+ }
}
}
}
@@ -103055,11 +103087,15 @@
"repositories"
]
},
- "example": {
- "repositories": [
- "github/Hello-World"
- ],
- "lock_repositories": true
+ "examples": {
+ "default": {
+ "value": {
+ "repositories": [
+ "github/Hello-World"
+ ],
+ "lock_repositories": true
+ }
+ }
}
}
}
@@ -116474,9 +116510,13 @@
"name"
]
},
- "example": {
- "name": "Organization Roadmap",
- "body": "High-level roadmap for the upcoming year."
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Organization Roadmap",
+ "body": "High-level roadmap for the upcoming year."
+ }
+ }
}
}
}
@@ -119821,14 +119861,18 @@
"name"
]
},
- "example": {
- "name": "Hello-World",
- "description": "This is your first repository",
- "homepage": "https://github.com",
- "private": false,
- "has_issues": true,
- "has_projects": true,
- "has_wiki": true
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Hello-World",
+ "description": "This is your first repository",
+ "homepage": "https://github.com",
+ "private": false,
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true
+ }
+ }
}
}
}
@@ -125405,11 +125449,15 @@
"name"
]
},
- "example": {
- "name": "Justice League",
- "description": "A great team",
- "permission": "push",
- "privacy": "closed"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Justice League",
+ "description": "A great team",
+ "permission": "push",
+ "privacy": "closed"
+ }
+ }
}
}
}
@@ -127009,10 +127057,14 @@
}
}
},
- "example": {
- "name": "new team name",
- "description": "new team description",
- "privacy": "closed"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "new team name",
+ "description": "new team description",
+ "privacy": "closed"
+ }
+ }
}
}
}
@@ -128305,9 +128357,13 @@
"body"
]
},
- "example": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Our first team post",
+ "body": "Hi! This is an area for us to collaborate as a team."
+ }
+ }
}
}
}
@@ -129252,8 +129308,12 @@
}
}
},
- "example": {
- "title": "Welcome to our first team post"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Welcome to our first team post"
+ }
+ }
}
}
}
@@ -130247,8 +130307,12 @@
"body"
]
},
- "example": {
- "body": "Do you like apples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like apples?"
+ }
+ }
}
}
}
@@ -131120,8 +131184,12 @@
"body"
]
},
- "example": {
- "body": "Do you like pineapples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like pineapples?"
+ }
+ }
}
}
}
@@ -133769,8 +133837,12 @@
"group_id"
]
},
- "example": {
- "group_id": 123
+ "examples": {
+ "default": {
+ "value": {
+ "group_id": 123
+ }
+ }
}
}
}
@@ -140992,14 +141064,18 @@
},
"additionalProperties": false
},
- "example": {
- "groups": [
- {
- "group_id": "123",
- "group_name": "Octocat admins",
- "group_description": "string"
+ "examples": {
+ "default": {
+ "value": {
+ "groups": [
+ {
+ "group_id": "123",
+ "group_name": "Octocat admins",
+ "group_description": "string"
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -160671,7 +160747,7 @@
"/repos/{owner}/{repo}/actions/permissions": {
"get": {
"summary": "Get GitHub Actions permissions for a repository",
- "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and workflows allowed to run in the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint. GitHub Apps must have the `administration` repository permission to use this API.",
+ "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.",
"operationId": "actions/get-github-actions-permissions-repository",
"tags": [
"actions"
@@ -160712,7 +160788,7 @@
},
"allowed_actions": {
"type": "string",
- "description": "The permissions policy that controls the actions and workflows that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.",
+ "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.",
"enum": [
"all",
"local_only",
@@ -160721,7 +160797,7 @@
},
"selected_actions_url": {
"type": "string",
- "description": "The API URL to use to get or set the actions and workflows that are allowed to run, when `allowed_actions` is set to `selected`."
+ "description": "The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`."
}
},
"required": [
@@ -160750,7 +160826,7 @@
},
"put": {
"summary": "Set GitHub Actions permissions for a repository",
- "description": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and workflows in the repository.\n\nIf the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions and workflows, then you cannot override them for the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.",
+ "description": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository.\n\nIf the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions and reusable workflows, then you cannot override them for the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.",
"operationId": "actions/set-github-actions-permissions-repository",
"tags": [
"actions"
@@ -160795,7 +160871,7 @@
},
"allowed_actions": {
"type": "string",
- "description": "The permissions policy that controls the actions and workflows that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.",
+ "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.",
"enum": [
"all",
"local_only",
@@ -160825,7 +160901,7 @@
"/repos/{owner}/{repo}/actions/permissions/access": {
"get": {
"summary": "Get the level of access for workflows outside of the repository",
- "description": "Gets the level of access that workflows outside of the repository have to actions and workflows in the repository.\nThis endpoint only applies to internal repositories. For more information, see \"[Managing GitHub Actions settings for a repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.",
+ "description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal repositories. For more information, see \"[Managing GitHub Actions settings for a repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.",
"tags": [
"actions"
],
@@ -160862,7 +160938,7 @@
"properties": {
"access_level": {
"type": "string",
- "description": "Defines the level of access that workflows outside of the repository have to actions and workflows within the\nrepository. `none` means access is only possible from workflows in this repository. Can be one of `none`, `organization`, `enterprise`.",
+ "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository. `none` means access is only possible from workflows in this repository. Can be one of `none`, `organization`, `enterprise`.",
"enum": [
"none",
"organization",
@@ -160897,7 +160973,7 @@
},
"put": {
"summary": "Set the level of access for workflows outside of the repository",
- "description": "Sets the level of access that workflows outside of the repository have to actions and workflows in the repository.\nThis endpoint only applies to internal repositories. For more information, see \"[Managing GitHub Actions settings for a repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.",
+ "description": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal repositories. For more information, see \"[Managing GitHub Actions settings for a repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.",
"tags": [
"actions"
],
@@ -160933,7 +161009,7 @@
"properties": {
"access_level": {
"type": "string",
- "description": "Defines the level of access that workflows outside of the repository have to actions and workflows within the\nrepository. `none` means access is only possible from workflows in this repository. Can be one of `none`, `organization`, `enterprise`.",
+ "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository. `none` means access is only possible from workflows in this repository. Can be one of `none`, `organization`, `enterprise`.",
"enum": [
"none",
"organization",
@@ -160973,8 +161049,8 @@
},
"/repos/{owner}/{repo}/actions/permissions/selected-actions": {
"get": {
- "summary": "Get allowed actions and workflows for a repository",
- "description": "Gets the settings for selected actions and workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.",
+ "summary": "Get allowed actions and reusable workflows for a repository",
+ "description": "Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.",
"operationId": "actions/get-allowed-actions-repository",
"tags": [
"actions"
@@ -161019,7 +161095,7 @@
},
"patterns_allowed": {
"type": "array",
- "description": "Specifies a list of string-matching patterns to allow specific action(s) and workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
+ "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
"items": {
"type": "string"
}
@@ -161050,8 +161126,8 @@
}
},
"put": {
- "summary": "Set allowed actions and workflows for a repository",
- "description": "Sets the actions and workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nIf the repository belongs to an organization or enterprise that has `selected` actions and workflows set at the organization or enterprise levels, then you cannot override any of the allowed actions and workflows settings.\n\nTo use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.",
+ "summary": "Set allowed actions and reusable workflows for a repository",
+ "description": "Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nIf the repository belongs to an organization or enterprise that has `selected` actions and reusable workflows set at the organization or enterprise levels, then you cannot override any of the allowed actions and reusable workflows settings.\n\nTo use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.",
"operationId": "actions/set-allowed-actions-repository",
"tags": [
"actions"
@@ -161100,7 +161176,7 @@
},
"patterns_allowed": {
"type": "array",
- "description": "Specifies a list of string-matching patterns to allow specific action(s) and workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
+ "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
"items": {
"type": "string"
}
@@ -192139,9 +192215,13 @@
"url_template"
]
},
- "example": {
- "key_prefix": "TICKET-",
- "url_template": "https://example.com/TICKET?query="
+ "examples": {
+ "default": {
+ "value": {
+ "key_prefix": "TICKET-",
+ "url_template": "https://example.com/TICKET?query="
+ }
+ }
}
}
}
@@ -200624,26 +200704,30 @@
}
}
},
- "example": {
- "dismissal_restrictions": {
- "users": [
- "octocat"
- ],
- "teams": [
- "justice-league"
- ]
- },
- "bypass_pull_request_allowances": {
- "users": [
- "octocat"
- ],
- "teams": [
- "justice-league"
- ]
- },
- "dismiss_stale_reviews": true,
- "require_code_owner_reviews": true,
- "required_approving_review_count": 2
+ "examples": {
+ "default": {
+ "value": {
+ "dismissal_restrictions": {
+ "users": [
+ "octocat"
+ ],
+ "teams": [
+ "justice-league"
+ ]
+ },
+ "bypass_pull_request_allowances": {
+ "users": [
+ "octocat"
+ ],
+ "teams": [
+ "justice-league"
+ ]
+ },
+ "dismiss_stale_reviews": true,
+ "require_code_owner_reviews": true,
+ "required_approving_review_count": 2
+ }
+ }
}
}
}
@@ -202221,11 +202305,15 @@
}
}
},
- "example": {
- "strict": true,
- "contexts": [
- "continuous-integration/travis-ci"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "strict": true,
+ "contexts": [
+ "continuous-integration/travis-ci"
+ ]
+ }
+ }
}
}
}
@@ -208705,8 +208793,12 @@
"new_name"
]
},
- "example": {
- "new_name": "my_renamed_branch"
+ "examples": {
+ "default": {
+ "value": {
+ "new_name": "my_renamed_branch"
+ }
+ }
}
}
}
@@ -221791,13 +221883,17 @@
}
}
},
- "example": {
- "auto_trigger_checks": [
- {
- "app_id": 4,
- "setting": false
+ "examples": {
+ "default": {
+ "value": {
+ "auto_trigger_checks": [
+ {
+ "app_id": 4,
+ "setting": false
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -230135,9 +230231,13 @@
"state"
]
},
- "example": {
- "state": "dismissed",
- "dismissed_reason": "false positive"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "dismissed",
+ "dismissed_reason": "false positive"
+ }
+ }
}
}
}
@@ -246374,8 +246474,12 @@
"body"
]
},
- "example": {
- "body": "Nice change"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Nice change"
+ }
+ }
}
}
}
@@ -247283,7 +247387,7 @@
"content"
]
},
- "example": {
+ "examples": {
"default": {
"value": {
"content": "heart"
@@ -249680,11 +249784,15 @@
"body"
]
},
- "example": {
- "body": "Great stuff",
- "path": "file1.txt",
- "position": 4,
- "line": 1
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Great stuff",
+ "path": "file1.txt",
+ "position": 4,
+ "line": 1
+ }
+ }
}
}
}
@@ -268389,13 +268497,17 @@
"sha"
]
},
- "example": {
- "message": "my commit message",
- "committer": {
- "name": "Monalisa Octocat",
- "email": "octocat@github.com"
- },
- "sha": "329688480d39049927147c162b9d2deaf885005f"
+ "examples": {
+ "default": {
+ "value": {
+ "message": "my commit message",
+ "committer": {
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com"
+ },
+ "sha": "329688480d39049927147c162b9d2deaf885005f"
+ }
+ }
}
}
}
@@ -272927,11 +273039,15 @@
"state"
]
},
- "example": {
- "environment": "production",
- "state": "success",
- "log_url": "https://example.com/deployment/42/output",
- "description": "Deployment finished successfully."
+ "examples": {
+ "default": {
+ "value": {
+ "environment": "production",
+ "state": "success",
+ "log_url": "https://example.com/deployment/42/output",
+ "description": "Deployment finished successfully."
+ }
+ }
}
}
}
@@ -289146,9 +289262,13 @@
"content"
]
},
- "example": {
- "content": "Content of the blob",
- "encoding": "utf-8"
+ "examples": {
+ "default": {
+ "value": {
+ "content": "Content of the blob",
+ "encoding": "utf-8"
+ }
+ }
}
}
}
@@ -290733,9 +290853,13 @@
"sha"
]
},
- "example": {
- "ref": "refs/heads/featureA",
- "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd"
+ "examples": {
+ "default": {
+ "value": {
+ "ref": "refs/heads/featureA",
+ "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd"
+ }
+ }
}
}
}
@@ -290964,9 +291088,13 @@
"sha"
]
},
- "example": {
- "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
- "force": true
+ "examples": {
+ "default": {
+ "value": {
+ "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
+ "force": true
+ }
+ }
}
}
}
@@ -291341,15 +291469,19 @@
"type"
]
},
- "example": {
- "tag": "v0.0.1",
- "message": "initial version",
- "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
- "type": "commit",
- "tagger": {
- "name": "Monalisa Octocat",
- "email": "octocat@github.com",
- "date": "2011-06-17T14:53:35-07:00"
+ "examples": {
+ "default": {
+ "value": {
+ "tag": "v0.0.1",
+ "message": "initial version",
+ "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
+ "type": "commit",
+ "tagger": {
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com",
+ "date": "2011-06-17T14:53:35-07:00"
+ }
+ }
}
}
}
@@ -291918,16 +292050,20 @@
"tree"
]
},
- "example": {
- "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
- "tree": [
- {
- "path": "file.rb",
- "mode": "100644",
- "type": "blob",
- "sha": "44b4fc6d56897b048c772eb4087f854f46256132"
+ "examples": {
+ "default": {
+ "value": {
+ "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
+ "tree": [
+ {
+ "path": "file.rb",
+ "mode": "100644",
+ "type": "blob",
+ "sha": "44b4fc6d56897b048c772eb4087f854f46256132"
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -292986,17 +293122,21 @@
},
"additionalProperties": false
},
- "example": {
- "name": "web",
- "active": true,
- "events": [
- "push",
- "pull_request"
- ],
- "config": {
- "url": "https://example.com/webhook",
- "content_type": "json",
- "insecure_ssl": "0"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "url": "https://example.com/webhook",
+ "content_type": "json",
+ "insecure_ssl": "0"
+ }
+ }
}
}
}
@@ -293834,11 +293974,15 @@
}
}
},
- "example": {
- "active": true,
- "add_events": [
- "pull_request"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "active": true,
+ "add_events": [
+ "pull_request"
+ ]
+ }
+ }
}
}
}
@@ -295983,11 +296127,15 @@
"vcs_url"
]
},
- "example": {
- "vcs": "subversion",
- "vcs_url": "http://svn.mycompany.com/svn/myproject",
- "vcs_username": "octocat",
- "vcs_password": "secret"
+ "examples": {
+ "default": {
+ "value": {
+ "vcs": "subversion",
+ "vcs_url": "http://svn.mycompany.com/svn/myproject",
+ "vcs_username": "octocat",
+ "vcs_password": "secret"
+ }
+ }
}
}
}
@@ -296846,9 +296994,13 @@
},
"additionalProperties": false
},
- "example": {
- "email": "hubot@github.com",
- "name": "Hubot the Robot"
+ "examples": {
+ "default": {
+ "value": {
+ "email": "hubot@github.com",
+ "name": "Hubot the Robot"
+ }
+ }
}
}
}
@@ -297172,8 +297324,12 @@
"use_lfs"
]
},
- "example": {
- "use_lfs": "opt_in"
+ "examples": {
+ "default": {
+ "value": {
+ "use_lfs": "opt_in"
+ }
+ }
}
}
}
@@ -307726,16 +307882,20 @@
"title"
]
},
- "example": {
- "title": "Found a bug",
- "body": "I'm having a problem with this.",
- "assignees": [
- "octocat"
- ],
- "milestone": 1,
- "labels": [
- "bug"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Found a bug",
+ "body": "I'm having a problem with this.",
+ "assignees": [
+ "octocat"
+ ],
+ "milestone": 1,
+ "labels": [
+ "bug"
+ ]
+ }
+ }
}
}
}
@@ -312777,8 +312937,12 @@
"body"
]
},
- "example": {
- "body": "Me too"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Me too"
+ }
+ }
}
}
}
@@ -331347,11 +331511,15 @@
}
}
},
- "example": {
- "assignees": [
- "hubot",
- "other_user"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "assignees": [
+ "hubot",
+ "other_user"
+ ]
+ }
+ }
}
}
}
@@ -334565,11 +334733,15 @@
}
}
},
- "example": {
- "assignees": [
- "hubot",
- "other_user"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "assignees": [
+ "hubot",
+ "other_user"
+ ]
+ }
+ }
}
}
}
@@ -338606,8 +338778,12 @@
"body"
]
},
- "example": {
- "body": "Me too"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Me too"
+ }
+ }
}
}
}
@@ -349911,11 +350087,15 @@
}
]
},
- "example": {
- "labels": [
- "bug",
- "enhancement"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "labels": [
+ "bug",
+ "enhancement"
+ ]
+ }
+ }
}
}
}
@@ -350234,11 +350414,15 @@
}
]
},
- "example": {
- "labels": [
- "bug",
- "enhancement"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "labels": [
+ "bug",
+ "enhancement"
+ ]
+ }
+ }
}
}
}
@@ -368012,10 +368196,14 @@
"key"
]
},
- "example": {
- "title": "octocat@octomac",
- "key": "ssh-rsa AAA...",
- "read_only": true
+ "examples": {
+ "default": {
+ "value": {
+ "title": "octocat@octomac",
+ "key": "ssh-rsa AAA...",
+ "read_only": true
+ }
+ }
}
}
}
@@ -368596,10 +368784,14 @@
"name"
]
},
- "example": {
- "name": "bug",
- "description": "Something isn't working",
- "color": "f29513"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513"
+ }
+ }
}
}
}
@@ -369026,10 +369218,14 @@
}
}
},
- "example": {
- "new_name": "bug :bug:",
- "description": "Small bug fix required",
- "color": "b01f26"
+ "examples": {
+ "default": {
+ "value": {
+ "new_name": "bug :bug:",
+ "description": "Small bug fix required",
+ "color": "b01f26"
+ }
+ }
}
}
}
@@ -369616,8 +369812,12 @@
"branch"
]
},
- "example": {
- "branch": "main"
+ "examples": {
+ "default": {
+ "value": {
+ "branch": "main"
+ }
+ }
}
}
}
@@ -371201,11 +371401,15 @@
"title"
]
},
- "example": {
- "title": "v1.0",
- "state": "open",
- "description": "Tracking milestone for version 1.0",
- "due_on": "2012-10-09T23:39:01Z"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "v1.0",
+ "state": "open",
+ "description": "Tracking milestone for version 1.0",
+ "due_on": "2012-10-09T23:39:01Z"
+ }
+ }
}
}
}
@@ -372182,11 +372386,15 @@
}
}
},
- "example": {
- "title": "v1.0",
- "state": "open",
- "description": "Tracking milestone for version 1.0",
- "due_on": "2012-10-09T23:39:01Z"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "v1.0",
+ "state": "open",
+ "description": "Tracking milestone for version 1.0",
+ "due_on": "2012-10-09T23:39:01Z"
+ }
+ }
}
}
}
@@ -378418,9 +378626,13 @@
"name"
]
},
- "example": {
- "name": "Projects Documentation",
- "body": "Developer documentation project for the developer site."
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Projects Documentation",
+ "body": "Developer documentation project for the developer site."
+ }
+ }
}
}
}
@@ -384596,11 +384808,15 @@
"base"
]
},
- "example": {
- "title": "Amazing new feature",
- "body": "Please pull these awesome changes in!",
- "head": "octocat:new-feature",
- "base": "master"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Amazing new feature",
+ "body": "Please pull these awesome changes in!",
+ "head": "octocat:new-feature",
+ "base": "master"
+ }
+ }
}
}
}
@@ -389832,8 +390048,12 @@
"body"
]
},
- "example": {
- "body": "I like this too!"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "I like this too!"
+ }
+ }
}
}
}
@@ -395514,11 +395734,15 @@
}
}
},
- "example": {
- "title": "new title",
- "body": "updated body",
- "state": "open",
- "base": "master"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "new title",
+ "body": "updated body",
+ "state": "open",
+ "base": "master"
+ }
+ }
}
}
}
@@ -406893,8 +407117,12 @@
"body"
]
},
- "example": {
- "body": "Great stuff!"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Great stuff!"
+ }
+ }
}
}
}
@@ -409578,15 +409806,19 @@
}
]
},
- "example": {
- "reviewers": [
- "octocat",
- "hubot",
- "other_user"
- ],
- "team_reviewers": [
- "justice-league"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "reviewers": [
+ "octocat",
+ "hubot",
+ "other_user"
+ ],
+ "team_reviewers": [
+ "justice-league"
+ ]
+ }
+ }
}
}
}
@@ -420666,17 +420898,21 @@
}
}
},
- "example": {
- "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
- "body": "This is close to perfect! Please address the suggested inline change.",
- "event": "REQUEST_CHANGES",
- "comments": [
- {
- "path": "file.md",
- "position": 6,
- "body": "Please add more information here, and fix this typo."
+ "examples": {
+ "default": {
+ "value": {
+ "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
+ "body": "This is close to perfect! Please address the suggested inline change.",
+ "event": "REQUEST_CHANGES",
+ "comments": [
+ {
+ "path": "file.md",
+ "position": 6,
+ "body": "Please add more information here, and fix this typo."
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -425680,14 +425916,18 @@
"tag_name"
]
},
- "example": {
- "tag_name": "v1.0.0",
- "target_commitish": "master",
- "name": "v1.0.0",
- "body": "Description of the release",
- "draft": false,
- "prerelease": false,
- "generate_release_notes": false
+ "examples": {
+ "default": {
+ "value": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "master",
+ "name": "v1.0.0",
+ "body": "Description of the release",
+ "draft": false,
+ "prerelease": false,
+ "generate_release_notes": false
+ }
+ }
}
}
}
@@ -426926,9 +427166,13 @@
}
}
},
- "example": {
- "name": "foo-1.0.0-osx.zip",
- "label": "Mac binary"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "foo-1.0.0-osx.zip",
+ "label": "Mac binary"
+ }
+ }
}
}
}
@@ -427338,11 +427582,15 @@
"tag_name"
]
},
- "example": {
- "tag_name": "v1.0.0",
- "target_commitish": "main",
- "previous_tag_name": "v0.9.2",
- "configuration_file_path": ".github/custom_release_config.yml"
+ "examples": {
+ "default": {
+ "value": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "main",
+ "previous_tag_name": "v0.9.2",
+ "configuration_file_path": ".github/custom_release_config.yml"
+ }
+ }
}
}
}
@@ -429686,13 +429934,17 @@
}
}
},
- "example": {
- "tag_name": "v1.0.0",
- "target_commitish": "master",
- "name": "v1.0.0",
- "body": "Description of the release",
- "draft": false,
- "prerelease": false
+ "examples": {
+ "default": {
+ "value": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "master",
+ "name": "v1.0.0",
+ "body": "Description of the release",
+ "draft": false,
+ "prerelease": false
+ }
+ }
}
}
}
@@ -433155,9 +433407,13 @@
"state"
]
},
- "example": {
- "state": "resolved",
- "resolution": "false_positive"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "resolved",
+ "resolution": "false_positive"
+ }
+ }
}
}
}
@@ -435169,11 +435425,15 @@
"state"
]
},
- "example": {
- "state": "success",
- "target_url": "https://example.com/build/status",
- "description": "The build succeeded!",
- "context": "continuous-integration/jenkins"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "success",
+ "target_url": "https://example.com/build/status",
+ "description": "The build succeeded!",
+ "context": "continuous-integration/jenkins"
+ }
+ }
}
}
}
@@ -436701,13 +436961,17 @@
"names"
]
},
- "example": {
- "names": [
- "octocat",
- "atom",
- "electron",
- "api"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "names": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ]
+ }
+ }
}
}
}
@@ -437619,12 +437883,16 @@
"new_owner"
]
},
- "example": {
- "new_owner": "github",
- "team_ids": [
- 12,
- 345
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "new_owner": "github",
+ "team_ids": [
+ 12,
+ 345
+ ]
+ }
+ }
}
}
}
@@ -440236,12 +440504,16 @@
"name"
]
},
- "example": {
- "owner": "octocat",
- "name": "Hello-World",
- "description": "This is your first repository",
- "include_all_branches": false,
- "private": false
+ "examples": {
+ "default": {
+ "value": {
+ "owner": "octocat",
+ "name": "Hello-World",
+ "description": "This is your first repository",
+ "include_all_branches": false,
+ "private": false
+ }
+ }
}
}
}
@@ -444837,19 +445109,23 @@
"displayName"
]
},
- "example": {
- "schemas": [
- "urn:ietf:params:scim:schemas:core:2.0:Group"
- ],
- "displayName": "octo-org",
- "members": [
- {
- "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc"
- },
- {
- "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5"
+ "examples": {
+ "default": {
+ "value": {
+ "schemas": [
+ "urn:ietf:params:scim:schemas:core:2.0:Group"
+ ],
+ "displayName": "octo-org",
+ "members": [
+ {
+ "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc"
+ },
+ {
+ "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5"
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -445180,19 +445456,23 @@
"displayName"
]
},
- "example": {
- "schemas": [
- "urn:ietf:params:scim:schemas:core:2.0:Group"
- ],
- "displayName": "octo-org",
- "members": [
- {
- "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc"
- },
- {
- "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5"
+ "examples": {
+ "default": {
+ "value": {
+ "schemas": [
+ "urn:ietf:params:scim:schemas:core:2.0:Group"
+ ],
+ "displayName": "octo-org",
+ "members": [
+ {
+ "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc"
+ },
+ {
+ "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5"
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -445385,21 +445665,25 @@
"Operations"
]
},
- "example": {
- "schemas": [
- "urn:ietf:params:scim:api:messages:2.0:PatchOp"
- ],
- "Operations": [
- {
- "op": "remove",
- "path": "members",
- "value": [
+ "examples": {
+ "default": {
+ "value": {
+ "schemas": [
+ "urn:ietf:params:scim:api:messages:2.0:PatchOp"
+ ],
+ "Operations": [
{
- "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5"
+ "op": "remove",
+ "path": "members",
+ "value": [
+ {
+ "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5"
+ }
+ ]
}
]
}
- ]
+ }
}
}
}
@@ -445906,27 +446190,31 @@
"emails"
]
},
- "example": {
- "schemas": [
- "urn:ietf:params:scim:schemas:core:2.0:User"
- ],
- "userName": "mona.octocat@okta.example.com",
- "name": {
- "familyName": "Octocat",
- "givenName": "Mona"
- },
- "emails": [
- {
- "value": "mona.octocat@okta.example.com",
- "type": "work",
- "primary": true
- }
- ],
- "groups": [
- {
- "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d"
+ "examples": {
+ "default": {
+ "value": {
+ "schemas": [
+ "urn:ietf:params:scim:schemas:core:2.0:User"
+ ],
+ "userName": "mona.octocat@okta.example.com",
+ "name": {
+ "familyName": "Octocat",
+ "givenName": "Mona"
+ },
+ "emails": [
+ {
+ "value": "mona.octocat@okta.example.com",
+ "type": "work",
+ "primary": true
+ }
+ ],
+ "groups": [
+ {
+ "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d"
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -446344,27 +446632,31 @@
"emails"
]
},
- "example": {
- "schemas": [
- "urn:ietf:params:scim:schemas:core:2.0:User"
- ],
- "userName": "mona.octocat@okta.example.com",
- "name": {
- "familyName": "Octocat",
- "givenName": "Mona"
- },
- "emails": [
- {
- "value": "mona.octocat@okta.example.com",
- "type": "work",
- "primary": true
- }
- ],
- "groups": [
- {
- "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d"
+ "examples": {
+ "default": {
+ "value": {
+ "schemas": [
+ "urn:ietf:params:scim:schemas:core:2.0:User"
+ ],
+ "userName": "mona.octocat@okta.example.com",
+ "name": {
+ "familyName": "Octocat",
+ "givenName": "Mona"
+ },
+ "emails": [
+ {
+ "value": "mona.octocat@okta.example.com",
+ "type": "work",
+ "primary": true
+ }
+ ],
+ "groups": [
+ {
+ "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d"
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -446561,27 +446853,31 @@
"Operations"
]
},
- "example": {
- "schemas": [
- "urn:ietf:params:scim:api:messages:2.0:PatchOp"
- ],
- "Operations": [
- {
- "op": "add",
- "path": "emails",
- "value": [
+ "examples": {
+ "default": {
+ "value": {
+ "schemas": [
+ "urn:ietf:params:scim:api:messages:2.0:PatchOp"
+ ],
+ "Operations": [
+ {
+ "op": "add",
+ "path": "emails",
+ "value": [
+ {
+ "value": "monalisa@octocat.github.com",
+ "type": "home"
+ }
+ ]
+ },
{
- "value": "monalisa@octocat.github.com",
- "type": "home"
+ "op": "replace",
+ "path": "name.givenName",
+ "value": "Monalisa"
}
]
- },
- {
- "op": "replace",
- "path": "name.givenName",
- "value": "Monalisa"
}
- ]
+ }
}
}
}
@@ -447478,6 +447774,95 @@
}
}
}
+ },
+ "429": {
+ "description": "Too Many Requests",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Scim Error",
+ "description": "Scim Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "documentation_url": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "detail": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "status": {
+ "type": "integer"
+ },
+ "scimType": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "schemas": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "application/scim+json": {
+ "schema": {
+ "title": "Scim Error",
+ "description": "Scim Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "documentation_url": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "detail": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "status": {
+ "type": "integer"
+ },
+ "scimType": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "schemas": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
}
},
"x-github": {
@@ -463924,9 +464309,13 @@
"body"
]
},
- "example": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Our first team post",
+ "body": "Hi! This is an area for us to collaborate as a team."
+ }
+ }
}
}
}
@@ -464859,8 +465248,12 @@
}
}
},
- "example": {
- "title": "Welcome to our first team post"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Welcome to our first team post"
+ }
+ }
}
}
}
@@ -465836,8 +466229,12 @@
"body"
]
},
- "example": {
- "body": "Do you like apples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like apples?"
+ }
+ }
}
}
}
@@ -466697,8 +467094,12 @@
"body"
]
},
- "example": {
- "body": "Do you like pineapples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like pineapples?"
+ }
+ }
}
}
}
@@ -467555,8 +467956,12 @@
"content"
]
},
- "example": {
- "content": "heart"
+ "examples": {
+ "default": {
+ "value": {
+ "content": "heart"
+ }
+ }
}
}
}
@@ -468231,8 +468636,12 @@
"content"
]
},
- "example": {
- "content": "heart"
+ "examples": {
+ "default": {
+ "value": {
+ "content": "heart"
+ }
+ }
}
}
}
@@ -476105,15 +476514,19 @@
"groups"
]
},
- "example": {
- "groups": [
- {
- "group_id": "123",
- "group_name": "Octocat admins",
- "description": "The people who configure your octoworld.",
- "group_description": "string"
+ "examples": {
+ "default": {
+ "value": {
+ "groups": [
+ {
+ "group_id": "123",
+ "group_name": "Octocat admins",
+ "description": "The people who configure your octoworld.",
+ "group_description": "string"
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -495079,8 +495492,12 @@
}
}
},
- "example": {
- "machine": "standardLinux"
+ "examples": {
+ "default": {
+ "value": {
+ "machine": "standardLinux"
+ }
+ }
}
}
}
@@ -517650,8 +518067,12 @@
"state"
]
},
- "example": {
- "state": "active"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "active"
+ }
+ }
}
}
}
diff --git a/lib/rest/static/dereferenced/ghes-3.1.deref.json b/lib/rest/static/dereferenced/ghes-3.1.deref.json
index 01059fbcfe2b..b7f650c4bbe3 100644
--- a/lib/rest/static/dereferenced/ghes-3.1.deref.json
+++ b/lib/rest/static/dereferenced/ghes-3.1.deref.json
@@ -674,16 +674,20 @@
"config"
]
},
- "example": {
- "name": "web",
- "events": [
- "organization",
- "user"
- ],
- "config": {
- "url": "https://example.com/webhook",
- "content_type": "json",
- "secret": "secret"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "events": [
+ "organization",
+ "user"
+ ],
+ "config": {
+ "url": "https://example.com/webhook",
+ "content_type": "json",
+ "secret": "secret"
+ }
+ }
}
}
}
@@ -1001,12 +1005,16 @@
}
}
},
- "example": {
- "events": [
- "organization"
- ],
- "config": {
- "url": "https://example.com/webhook"
+ "examples": {
+ "default": {
+ "value": {
+ "events": [
+ "organization"
+ ],
+ "config": {
+ "url": "https://example.com/webhook"
+ }
+ }
}
}
}
@@ -1461,8 +1469,12 @@
"ldap_dn"
]
},
- "example": {
- "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
+ "examples": {
+ "default": {
+ "value": {
+ "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
+ }
+ }
}
}
}
@@ -1968,8 +1980,12 @@
"ldap_dn"
]
},
- "example": {
- "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
+ "examples": {
+ "default": {
+ "value": {
+ "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
+ }
+ }
}
}
}
@@ -2195,10 +2211,14 @@
"admin"
]
},
- "example": {
- "login": "github",
- "profile_name": "GitHub, Inc.",
- "admin": "monalisaoctocat"
+ "examples": {
+ "default": {
+ "value": {
+ "login": "github",
+ "profile_name": "GitHub, Inc.",
+ "admin": "monalisaoctocat"
+ }
+ }
}
}
}
@@ -2575,9 +2595,13 @@
"image_url"
]
},
- "example": {
- "name": "DevTools Hook Env",
- "image_url": "https://my_file_server/path/to/devtools_env.tar.gz"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "DevTools Hook Env",
+ "image_url": "https://my_file_server/path/to/devtools_env.tar.gz"
+ }
+ }
}
}
}
@@ -3577,16 +3601,20 @@
"environment"
]
},
- "example": {
- "name": "Check Commits",
- "script": "scripts/commit_check.sh",
- "enforcement": "disabled",
- "allow_downstream_configuration": false,
- "script_repository": {
- "full_name": "DevIT/hooks"
- },
- "environment": {
- "id": 2
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Check Commits",
+ "script": "scripts/commit_check.sh",
+ "enforcement": "disabled",
+ "allow_downstream_configuration": false,
+ "script_repository": {
+ "full_name": "DevIT/hooks"
+ },
+ "environment": {
+ "id": 2
+ }
+ }
}
}
}
@@ -3964,12 +3992,16 @@
}
}
},
- "example": {
- "name": "Check Commits",
- "environment": {
- "id": 1
- },
- "allow_downstream_configuration": true
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Check Commits",
+ "environment": {
+ "id": 1
+ },
+ "allow_downstream_configuration": true
+ }
+ }
}
}
}
@@ -5138,9 +5170,13 @@
"login"
]
},
- "example": {
- "login": "monalisa",
- "email": "octocat@github.com"
+ "examples": {
+ "default": {
+ "value": {
+ "login": "monalisa",
+ "email": "octocat@github.com"
+ }
+ }
}
}
}
@@ -28042,17 +28078,21 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected",
- "selected_organization_ids": [
- 32,
- 91
- ],
- "runners": [
- 9,
- 2
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected",
+ "selected_organization_ids": [
+ 32,
+ 91
+ ],
+ "runners": [
+ 9,
+ 2
+ ]
+ }
+ }
}
}
}
@@ -28274,9 +28314,13 @@
}
}
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected"
+ }
+ }
}
}
}
@@ -64738,17 +64782,21 @@
}
}
},
- "example": {
- "billing_email": "mona@github.com",
- "company": "GitHub",
- "email": "mona@github.com",
- "twitter_username": "github",
- "location": "San Francisco",
- "name": "github",
- "description": "GitHub, the company.",
- "default_repository_permission": "read",
- "members_can_create_repositories": true,
- "members_allowed_repository_creation_type": "all"
+ "examples": {
+ "default": {
+ "value": {
+ "billing_email": "mona@github.com",
+ "company": "GitHub",
+ "email": "mona@github.com",
+ "twitter_username": "github",
+ "location": "San Francisco",
+ "name": "github",
+ "description": "GitHub, the company.",
+ "default_repository_permission": "read",
+ "members_can_create_repositories": true,
+ "members_allowed_repository_creation_type": "all"
+ }
+ }
}
}
}
@@ -67532,17 +67580,21 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected",
- "selected_repository_ids": [
- 32,
- 91
- ],
- "runners": [
- 9,
- 2
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected",
+ "selected_repository_ids": [
+ 32,
+ 91
+ ],
+ "runners": [
+ 9,
+ 2
+ ]
+ }
+ }
}
}
}
@@ -67783,9 +67835,13 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected"
+ }
+ }
}
}
}
@@ -81435,16 +81491,20 @@
"config"
]
},
- "example": {
- "name": "web",
- "active": true,
- "events": [
- "push",
- "pull_request"
- ],
- "config": {
- "url": "http://example.com/webhook",
- "content_type": "json"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "url": "http://example.com/webhook",
+ "content_type": "json"
+ }
+ }
}
}
}
@@ -82010,11 +82070,15 @@
}
}
},
- "example": {
- "active": true,
- "events": [
- "pull_request"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "active": true,
+ "events": [
+ "pull_request"
+ ]
+ }
+ }
}
}
}
@@ -90280,9 +90344,13 @@
}
}
},
- "example": {
- "enforcement": "enabled",
- "allow_downstream_configuration": false
+ "examples": {
+ "default": {
+ "value": {
+ "enforcement": "enabled",
+ "allow_downstream_configuration": false
+ }
+ }
}
}
}
@@ -90870,9 +90938,13 @@
"name"
]
},
- "example": {
- "name": "Organization Roadmap",
- "body": "High-level roadmap for the upcoming year."
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Organization Roadmap",
+ "body": "High-level roadmap for the upcoming year."
+ }
+ }
}
}
}
@@ -94209,14 +94281,18 @@
"name"
]
},
- "example": {
- "name": "Hello-World",
- "description": "This is your first repository",
- "homepage": "https://github.com",
- "private": false,
- "has_issues": true,
- "has_projects": true,
- "has_wiki": true
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Hello-World",
+ "description": "This is your first repository",
+ "homepage": "https://github.com",
+ "private": false,
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true
+ }
+ }
}
}
}
@@ -96228,11 +96304,15 @@
"name"
]
},
- "example": {
- "name": "Justice League",
- "description": "A great team",
- "permission": "push",
- "privacy": "closed"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Justice League",
+ "description": "A great team",
+ "permission": "push",
+ "privacy": "closed"
+ }
+ }
}
}
}
@@ -97812,10 +97892,14 @@
}
}
},
- "example": {
- "name": "new team name",
- "description": "new team description",
- "privacy": "closed"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "new team name",
+ "description": "new team description",
+ "privacy": "closed"
+ }
+ }
}
}
}
@@ -99104,9 +99188,13 @@
"body"
]
},
- "example": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Our first team post",
+ "body": "Hi! This is an area for us to collaborate as a team."
+ }
+ }
}
}
}
@@ -100063,8 +100151,12 @@
}
}
},
- "example": {
- "title": "Welcome to our first team post"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Welcome to our first team post"
+ }
+ }
}
}
}
@@ -101070,8 +101162,12 @@
"body"
]
},
- "example": {
- "body": "Do you like apples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like apples?"
+ }
+ }
}
}
}
@@ -101955,8 +102051,12 @@
"body"
]
},
- "example": {
- "body": "Do you like pineapples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like pineapples?"
+ }
+ }
}
}
}
@@ -130737,7 +130837,7 @@
"/repos/{owner}/{repo}/actions/permissions": {
"get": {
"summary": "Get GitHub Actions permissions for a repository",
- "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint. GitHub Apps must have the `administration` repository permission to use this API.",
+ "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.",
"operationId": "actions/get-github-actions-permissions-repository",
"tags": [
"actions"
@@ -157685,26 +157785,30 @@
}
}
},
- "example": {
- "dismissal_restrictions": {
- "users": [
- "octocat"
- ],
- "teams": [
- "justice-league"
- ]
- },
- "bypass_pull_request_allowances": {
- "users": [
- "octocat"
- ],
- "teams": [
- "justice-league"
- ]
- },
- "dismiss_stale_reviews": true,
- "require_code_owner_reviews": true,
- "required_approving_review_count": 2
+ "examples": {
+ "default": {
+ "value": {
+ "dismissal_restrictions": {
+ "users": [
+ "octocat"
+ ],
+ "teams": [
+ "justice-league"
+ ]
+ },
+ "bypass_pull_request_allowances": {
+ "users": [
+ "octocat"
+ ],
+ "teams": [
+ "justice-league"
+ ]
+ },
+ "dismiss_stale_reviews": true,
+ "require_code_owner_reviews": true,
+ "required_approving_review_count": 2
+ }
+ }
}
}
}
@@ -158886,11 +158990,15 @@
}
}
},
- "example": {
- "strict": true,
- "contexts": [
- "continuous-integration/travis-ci"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "strict": true,
+ "contexts": [
+ "continuous-integration/travis-ci"
+ ]
+ }
+ }
}
}
}
@@ -165345,8 +165453,12 @@
"new_name"
]
},
- "example": {
- "new_name": "my_renamed_branch"
+ "examples": {
+ "default": {
+ "value": {
+ "new_name": "my_renamed_branch"
+ }
+ }
}
}
}
@@ -177854,13 +177966,17 @@
}
}
},
- "example": {
- "auto_trigger_checks": [
- {
- "app_id": 4,
- "setting": false
+ "examples": {
+ "default": {
+ "value": {
+ "auto_trigger_checks": [
+ {
+ "app_id": 4,
+ "setting": false
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -186060,9 +186176,13 @@
"state"
]
},
- "example": {
- "state": "dismissed",
- "dismissed_reason": "false positive"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "dismissed",
+ "dismissed_reason": "false positive"
+ }
+ }
}
}
}
@@ -192591,8 +192711,12 @@
"body"
]
},
- "example": {
- "body": "Nice change"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Nice change"
+ }
+ }
}
}
}
@@ -193505,7 +193629,7 @@
"content"
]
},
- "example": {
+ "examples": {
"default": {
"value": {
"content": "heart"
@@ -195924,11 +196048,15 @@
"body"
]
},
- "example": {
- "body": "Great stuff",
- "path": "file1.txt",
- "position": 4,
- "line": 1
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Great stuff",
+ "path": "file1.txt",
+ "position": 4,
+ "line": 1
+ }
+ }
}
}
}
@@ -214490,13 +214618,17 @@
"sha"
]
},
- "example": {
- "message": "my commit message",
- "committer": {
- "name": "Monalisa Octocat",
- "email": "octocat@github.com"
- },
- "sha": "329688480d39049927147c162b9d2deaf885005f"
+ "examples": {
+ "default": {
+ "value": {
+ "message": "my commit message",
+ "committer": {
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com"
+ },
+ "sha": "329688480d39049927147c162b9d2deaf885005f"
+ }
+ }
}
}
}
@@ -218616,11 +218748,15 @@
"state"
]
},
- "example": {
- "environment": "production",
- "state": "success",
- "log_url": "https://example.com/deployment/42/output",
- "description": "Deployment finished successfully."
+ "examples": {
+ "default": {
+ "value": {
+ "environment": "production",
+ "state": "success",
+ "log_url": "https://example.com/deployment/42/output",
+ "description": "Deployment finished successfully."
+ }
+ }
}
}
}
@@ -232474,9 +232610,13 @@
"content"
]
},
- "example": {
- "content": "Content of the blob",
- "encoding": "utf-8"
+ "examples": {
+ "default": {
+ "value": {
+ "content": "Content of the blob",
+ "encoding": "utf-8"
+ }
+ }
}
}
}
@@ -234061,9 +234201,13 @@
"sha"
]
},
- "example": {
- "ref": "refs/heads/featureA",
- "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd"
+ "examples": {
+ "default": {
+ "value": {
+ "ref": "refs/heads/featureA",
+ "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd"
+ }
+ }
}
}
}
@@ -234292,9 +234436,13 @@
"sha"
]
},
- "example": {
- "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
- "force": true
+ "examples": {
+ "default": {
+ "value": {
+ "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
+ "force": true
+ }
+ }
}
}
}
@@ -234669,15 +234817,19 @@
"type"
]
},
- "example": {
- "tag": "v0.0.1",
- "message": "initial version",
- "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
- "type": "commit",
- "tagger": {
- "name": "Monalisa Octocat",
- "email": "octocat@github.com",
- "date": "2011-06-17T14:53:35-07:00"
+ "examples": {
+ "default": {
+ "value": {
+ "tag": "v0.0.1",
+ "message": "initial version",
+ "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
+ "type": "commit",
+ "tagger": {
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com",
+ "date": "2011-06-17T14:53:35-07:00"
+ }
+ }
}
}
}
@@ -235246,16 +235398,20 @@
"tree"
]
},
- "example": {
- "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
- "tree": [
- {
- "path": "file.rb",
- "mode": "100644",
- "type": "blob",
- "sha": "44b4fc6d56897b048c772eb4087f854f46256132"
+ "examples": {
+ "default": {
+ "value": {
+ "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
+ "tree": [
+ {
+ "path": "file.rb",
+ "mode": "100644",
+ "type": "blob",
+ "sha": "44b4fc6d56897b048c772eb4087f854f46256132"
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -236306,17 +236462,21 @@
},
"additionalProperties": false
},
- "example": {
- "name": "web",
- "active": true,
- "events": [
- "push",
- "pull_request"
- ],
- "config": {
- "url": "https://example.com/webhook",
- "content_type": "json",
- "insecure_ssl": "0"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "url": "https://example.com/webhook",
+ "content_type": "json",
+ "insecure_ssl": "0"
+ }
+ }
}
}
}
@@ -237138,11 +237298,15 @@
}
}
},
- "example": {
- "active": true,
- "add_events": [
- "pull_request"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "active": true,
+ "add_events": [
+ "pull_request"
+ ]
+ }
+ }
}
}
}
@@ -247968,16 +248132,20 @@
"title"
]
},
- "example": {
- "title": "Found a bug",
- "body": "I'm having a problem with this.",
- "assignees": [
- "octocat"
- ],
- "milestone": 1,
- "labels": [
- "bug"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Found a bug",
+ "body": "I'm having a problem with this.",
+ "assignees": [
+ "octocat"
+ ],
+ "milestone": 1,
+ "labels": [
+ "bug"
+ ]
+ }
+ }
}
}
}
@@ -253024,8 +253192,12 @@
"body"
]
},
- "example": {
- "body": "Me too"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Me too"
+ }
+ }
}
}
}
@@ -271582,11 +271754,15 @@
}
}
},
- "example": {
- "assignees": [
- "hubot",
- "other_user"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "assignees": [
+ "hubot",
+ "other_user"
+ ]
+ }
+ }
}
}
}
@@ -274789,11 +274965,15 @@
}
}
},
- "example": {
- "assignees": [
- "hubot",
- "other_user"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "assignees": [
+ "hubot",
+ "other_user"
+ ]
+ }
+ }
}
}
}
@@ -278825,8 +279005,12 @@
"body"
]
},
- "example": {
- "body": "Me too"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Me too"
+ }
+ }
}
}
}
@@ -290136,11 +290320,15 @@
}
]
},
- "example": {
- "labels": [
- "bug",
- "enhancement"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "labels": [
+ "bug",
+ "enhancement"
+ ]
+ }
+ }
}
}
}
@@ -290459,11 +290647,15 @@
}
]
},
- "example": {
- "labels": [
- "bug",
- "enhancement"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "labels": [
+ "bug",
+ "enhancement"
+ ]
+ }
+ }
}
}
}
@@ -308251,10 +308443,14 @@
"key"
]
},
- "example": {
- "title": "octocat@octomac",
- "key": "ssh-rsa AAA...",
- "read_only": true
+ "examples": {
+ "default": {
+ "value": {
+ "title": "octocat@octomac",
+ "key": "ssh-rsa AAA...",
+ "read_only": true
+ }
+ }
}
}
}
@@ -308835,10 +309031,14 @@
"name"
]
},
- "example": {
- "name": "bug",
- "description": "Something isn't working",
- "color": "f29513"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513"
+ }
+ }
}
}
}
@@ -309265,10 +309465,14 @@
}
}
},
- "example": {
- "new_name": "bug :bug:",
- "description": "Small bug fix required",
- "color": "b01f26"
+ "examples": {
+ "default": {
+ "value": {
+ "new_name": "bug :bug:",
+ "description": "Small bug fix required",
+ "color": "b01f26"
+ }
+ }
}
}
}
@@ -311241,11 +311445,15 @@
"title"
]
},
- "example": {
- "title": "v1.0",
- "state": "open",
- "description": "Tracking milestone for version 1.0",
- "due_on": "2012-10-09T23:39:01Z"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "v1.0",
+ "state": "open",
+ "description": "Tracking milestone for version 1.0",
+ "due_on": "2012-10-09T23:39:01Z"
+ }
+ }
}
}
}
@@ -312222,11 +312430,15 @@
}
}
},
- "example": {
- "title": "v1.0",
- "state": "open",
- "description": "Tracking milestone for version 1.0",
- "due_on": "2012-10-09T23:39:01Z"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "v1.0",
+ "state": "open",
+ "description": "Tracking milestone for version 1.0",
+ "due_on": "2012-10-09T23:39:01Z"
+ }
+ }
}
}
}
@@ -317706,8 +317918,12 @@
}
}
},
- "example": {
- "enforcement": "enabled"
+ "examples": {
+ "default": {
+ "value": {
+ "enforcement": "enabled"
+ }
+ }
}
}
}
@@ -318419,9 +318635,13 @@
"name"
]
},
- "example": {
- "name": "Projects Documentation",
- "body": "Developer documentation project for the developer site."
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Projects Documentation",
+ "body": "Developer documentation project for the developer site."
+ }
+ }
}
}
}
@@ -324578,11 +324798,15 @@
"base"
]
},
- "example": {
- "title": "Amazing new feature",
- "body": "Please pull these awesome changes in!",
- "head": "octocat:new-feature",
- "base": "master"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Amazing new feature",
+ "body": "Please pull these awesome changes in!",
+ "head": "octocat:new-feature",
+ "base": "master"
+ }
+ }
}
}
}
@@ -329834,8 +330058,12 @@
"body"
]
},
- "example": {
- "body": "I like this too!"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "I like this too!"
+ }
+ }
}
}
}
@@ -335537,11 +335765,15 @@
}
}
},
- "example": {
- "title": "new title",
- "body": "updated body",
- "state": "open",
- "base": "master"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "new title",
+ "body": "updated body",
+ "state": "open",
+ "base": "master"
+ }
+ }
}
}
}
@@ -340957,8 +341189,12 @@
"body"
]
},
- "example": {
- "body": "Great stuff!"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Great stuff!"
+ }
+ }
}
}
}
@@ -343642,15 +343878,19 @@
}
]
},
- "example": {
- "reviewers": [
- "octocat",
- "hubot",
- "other_user"
- ],
- "team_reviewers": [
- "justice-league"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "reviewers": [
+ "octocat",
+ "hubot",
+ "other_user"
+ ],
+ "team_reviewers": [
+ "justice-league"
+ ]
+ }
+ }
}
}
}
@@ -354679,17 +354919,21 @@
}
}
},
- "example": {
- "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
- "body": "This is close to perfect! Please address the suggested inline change.",
- "event": "REQUEST_CHANGES",
- "comments": [
- {
- "path": "file.md",
- "position": 6,
- "body": "Please add more information here, and fix this typo."
+ "examples": {
+ "default": {
+ "value": {
+ "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
+ "body": "This is close to perfect! Please address the suggested inline change.",
+ "event": "REQUEST_CHANGES",
+ "comments": [
+ {
+ "path": "file.md",
+ "position": 6,
+ "body": "Please add more information here, and fix this typo."
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -359681,13 +359925,17 @@
"tag_name"
]
},
- "example": {
- "tag_name": "v1.0.0",
- "target_commitish": "master",
- "name": "v1.0.0",
- "body": "Description of the release",
- "draft": false,
- "prerelease": false
+ "examples": {
+ "default": {
+ "value": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "master",
+ "name": "v1.0.0",
+ "body": "Description of the release",
+ "draft": false,
+ "prerelease": false
+ }
+ }
}
}
}
@@ -360892,9 +361140,13 @@
}
}
},
- "example": {
- "name": "foo-1.0.0-osx.zip",
- "label": "Mac binary"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "foo-1.0.0-osx.zip",
+ "label": "Mac binary"
+ }
+ }
}
}
}
@@ -363484,13 +363736,17 @@
}
}
},
- "example": {
- "tag_name": "v1.0.0",
- "target_commitish": "master",
- "name": "v1.0.0",
- "body": "Description of the release",
- "draft": false,
- "prerelease": false
+ "examples": {
+ "default": {
+ "value": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "master",
+ "name": "v1.0.0",
+ "body": "Description of the release",
+ "draft": false,
+ "prerelease": false
+ }
+ }
}
}
}
@@ -365777,9 +366033,13 @@
"state"
]
},
- "example": {
- "state": "resolved",
- "resolution": "false_positive"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "resolved",
+ "resolution": "false_positive"
+ }
+ }
}
}
}
@@ -367541,11 +367801,15 @@
"state"
]
},
- "example": {
- "state": "success",
- "target_url": "https://example.com/build/status",
- "description": "The build succeeded!",
- "context": "continuous-integration/jenkins"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "success",
+ "target_url": "https://example.com/build/status",
+ "description": "The build succeeded!",
+ "context": "continuous-integration/jenkins"
+ }
+ }
}
}
}
@@ -369100,13 +369364,17 @@
"names"
]
},
- "example": {
- "names": [
- "octocat",
- "atom",
- "electron",
- "api"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "names": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ]
+ }
+ }
}
}
}
@@ -369292,12 +369560,16 @@
"new_owner"
]
},
- "example": {
- "new_owner": "github",
- "team_ids": [
- 12,
- 345
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "new_owner": "github",
+ "team_ids": [
+ 12,
+ 345
+ ]
+ }
+ }
}
}
}
@@ -371761,12 +372033,16 @@
"name"
]
},
- "example": {
- "owner": "octocat",
- "name": "Hello-World",
- "description": "This is your first repository",
- "include_all_branches": false,
- "private": false
+ "examples": {
+ "default": {
+ "value": {
+ "owner": "octocat",
+ "name": "Hello-World",
+ "description": "This is your first repository",
+ "include_all_branches": false,
+ "private": false
+ }
+ }
}
}
}
@@ -390440,9 +390716,13 @@
"body"
]
},
- "example": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Our first team post",
+ "body": "Hi! This is an area for us to collaborate as a team."
+ }
+ }
}
}
}
@@ -391387,8 +391667,12 @@
}
}
},
- "example": {
- "title": "Welcome to our first team post"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Welcome to our first team post"
+ }
+ }
}
}
}
@@ -392376,8 +392660,12 @@
"body"
]
},
- "example": {
- "body": "Do you like apples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like apples?"
+ }
+ }
}
}
}
@@ -393249,8 +393537,12 @@
"body"
]
},
- "example": {
- "body": "Do you like pineapples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like pineapples?"
+ }
+ }
}
}
}
@@ -394118,8 +394410,12 @@
"content"
]
},
- "example": {
- "content": "heart"
+ "examples": {
+ "default": {
+ "value": {
+ "content": "heart"
+ }
+ }
}
}
}
@@ -394804,8 +395100,12 @@
"content"
]
},
- "example": {
- "content": "heart"
+ "examples": {
+ "default": {
+ "value": {
+ "content": "heart"
+ }
+ }
}
}
}
@@ -415102,8 +415402,12 @@
"state"
]
},
- "example": {
- "state": "active"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "active"
+ }
+ }
}
}
}
diff --git a/lib/rest/static/dereferenced/ghes-3.2.deref.json b/lib/rest/static/dereferenced/ghes-3.2.deref.json
index 0d02e2cfcf18..939a0a697f42 100644
--- a/lib/rest/static/dereferenced/ghes-3.2.deref.json
+++ b/lib/rest/static/dereferenced/ghes-3.2.deref.json
@@ -674,16 +674,20 @@
"config"
]
},
- "example": {
- "name": "web",
- "events": [
- "organization",
- "user"
- ],
- "config": {
- "url": "https://example.com/webhook",
- "content_type": "json",
- "secret": "secret"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "events": [
+ "organization",
+ "user"
+ ],
+ "config": {
+ "url": "https://example.com/webhook",
+ "content_type": "json",
+ "secret": "secret"
+ }
+ }
}
}
}
@@ -1001,12 +1005,16 @@
}
}
},
- "example": {
- "events": [
- "organization"
- ],
- "config": {
- "url": "https://example.com/webhook"
+ "examples": {
+ "default": {
+ "value": {
+ "events": [
+ "organization"
+ ],
+ "config": {
+ "url": "https://example.com/webhook"
+ }
+ }
}
}
}
@@ -1461,8 +1469,12 @@
"ldap_dn"
]
},
- "example": {
- "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
+ "examples": {
+ "default": {
+ "value": {
+ "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
+ }
+ }
}
}
}
@@ -1968,8 +1980,12 @@
"ldap_dn"
]
},
- "example": {
- "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
+ "examples": {
+ "default": {
+ "value": {
+ "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
+ }
+ }
}
}
}
@@ -2195,10 +2211,14 @@
"admin"
]
},
- "example": {
- "login": "github",
- "profile_name": "GitHub, Inc.",
- "admin": "monalisaoctocat"
+ "examples": {
+ "default": {
+ "value": {
+ "login": "github",
+ "profile_name": "GitHub, Inc.",
+ "admin": "monalisaoctocat"
+ }
+ }
}
}
}
@@ -2575,9 +2595,13 @@
"image_url"
]
},
- "example": {
- "name": "DevTools Hook Env",
- "image_url": "https://my_file_server/path/to/devtools_env.tar.gz"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "DevTools Hook Env",
+ "image_url": "https://my_file_server/path/to/devtools_env.tar.gz"
+ }
+ }
}
}
}
@@ -3577,16 +3601,20 @@
"environment"
]
},
- "example": {
- "name": "Check Commits",
- "script": "scripts/commit_check.sh",
- "enforcement": "disabled",
- "allow_downstream_configuration": false,
- "script_repository": {
- "full_name": "DevIT/hooks"
- },
- "environment": {
- "id": 2
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Check Commits",
+ "script": "scripts/commit_check.sh",
+ "enforcement": "disabled",
+ "allow_downstream_configuration": false,
+ "script_repository": {
+ "full_name": "DevIT/hooks"
+ },
+ "environment": {
+ "id": 2
+ }
+ }
}
}
}
@@ -3964,12 +3992,16 @@
}
}
},
- "example": {
- "name": "Check Commits",
- "environment": {
- "id": 1
- },
- "allow_downstream_configuration": true
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Check Commits",
+ "environment": {
+ "id": 1
+ },
+ "allow_downstream_configuration": true
+ }
+ }
}
}
}
@@ -5145,9 +5177,13 @@
"login"
]
},
- "example": {
- "login": "monalisa",
- "email": "octocat@github.com"
+ "examples": {
+ "default": {
+ "value": {
+ "login": "monalisa",
+ "email": "octocat@github.com"
+ }
+ }
}
}
}
@@ -29081,17 +29117,21 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected",
- "selected_organization_ids": [
- 32,
- 91
- ],
- "runners": [
- 9,
- 2
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected",
+ "selected_organization_ids": [
+ 32,
+ 91
+ ],
+ "runners": [
+ 9,
+ 2
+ ]
+ }
+ }
}
}
}
@@ -29313,9 +29353,13 @@
}
}
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected"
+ }
+ }
}
}
}
@@ -65877,17 +65921,21 @@
}
}
},
- "example": {
- "billing_email": "mona@github.com",
- "company": "GitHub",
- "email": "mona@github.com",
- "twitter_username": "github",
- "location": "San Francisco",
- "name": "github",
- "description": "GitHub, the company.",
- "default_repository_permission": "read",
- "members_can_create_repositories": true,
- "members_allowed_repository_creation_type": "all"
+ "examples": {
+ "default": {
+ "value": {
+ "billing_email": "mona@github.com",
+ "company": "GitHub",
+ "email": "mona@github.com",
+ "twitter_username": "github",
+ "location": "San Francisco",
+ "name": "github",
+ "description": "GitHub, the company.",
+ "default_repository_permission": "read",
+ "members_can_create_repositories": true,
+ "members_allowed_repository_creation_type": "all"
+ }
+ }
}
}
}
@@ -68683,17 +68731,21 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected",
- "selected_repository_ids": [
- 32,
- 91
- ],
- "runners": [
- 9,
- 2
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected",
+ "selected_repository_ids": [
+ 32,
+ 91
+ ],
+ "runners": [
+ 9,
+ 2
+ ]
+ }
+ }
}
}
}
@@ -68934,9 +68986,13 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected"
+ }
+ }
}
}
}
@@ -82660,16 +82716,20 @@
"config"
]
},
- "example": {
- "name": "web",
- "active": true,
- "events": [
- "push",
- "pull_request"
- ],
- "config": {
- "url": "http://example.com/webhook",
- "content_type": "json"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "url": "http://example.com/webhook",
+ "content_type": "json"
+ }
+ }
}
}
}
@@ -83251,11 +83311,15 @@
}
}
},
- "example": {
- "active": true,
- "events": [
- "pull_request"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "active": true,
+ "events": [
+ "pull_request"
+ ]
+ }
+ }
}
}
}
@@ -92503,9 +92567,13 @@
}
}
},
- "example": {
- "enforcement": "enabled",
- "allow_downstream_configuration": false
+ "examples": {
+ "default": {
+ "value": {
+ "enforcement": "enabled",
+ "allow_downstream_configuration": false
+ }
+ }
}
}
}
@@ -93093,9 +93161,13 @@
"name"
]
},
- "example": {
- "name": "Organization Roadmap",
- "body": "High-level roadmap for the upcoming year."
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Organization Roadmap",
+ "body": "High-level roadmap for the upcoming year."
+ }
+ }
}
}
}
@@ -96448,14 +96520,18 @@
"name"
]
},
- "example": {
- "name": "Hello-World",
- "description": "This is your first repository",
- "homepage": "https://github.com",
- "private": false,
- "has_issues": true,
- "has_projects": true,
- "has_wiki": true
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Hello-World",
+ "description": "This is your first repository",
+ "homepage": "https://github.com",
+ "private": false,
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true
+ }
+ }
}
}
}
@@ -98473,11 +98549,15 @@
"name"
]
},
- "example": {
- "name": "Justice League",
- "description": "A great team",
- "permission": "push",
- "privacy": "closed"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Justice League",
+ "description": "A great team",
+ "permission": "push",
+ "privacy": "closed"
+ }
+ }
}
}
}
@@ -100057,10 +100137,14 @@
}
}
},
- "example": {
- "name": "new team name",
- "description": "new team description",
- "privacy": "closed"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "new team name",
+ "description": "new team description",
+ "privacy": "closed"
+ }
+ }
}
}
}
@@ -101349,9 +101433,13 @@
"body"
]
},
- "example": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Our first team post",
+ "body": "Hi! This is an area for us to collaborate as a team."
+ }
+ }
}
}
}
@@ -102308,8 +102396,12 @@
}
}
},
- "example": {
- "title": "Welcome to our first team post"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Welcome to our first team post"
+ }
+ }
}
}
}
@@ -103315,8 +103407,12 @@
"body"
]
},
- "example": {
- "body": "Do you like apples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like apples?"
+ }
+ }
}
}
}
@@ -104200,8 +104296,12 @@
"body"
]
},
- "example": {
- "body": "Do you like pineapples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like pineapples?"
+ }
+ }
}
}
}
@@ -133240,7 +133340,7 @@
"/repos/{owner}/{repo}/actions/permissions": {
"get": {
"summary": "Get GitHub Actions permissions for a repository",
- "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint. GitHub Apps must have the `administration` repository permission to use this API.",
+ "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.",
"operationId": "actions/get-github-actions-permissions-repository",
"tags": [
"actions"
@@ -162004,26 +162104,30 @@
}
}
},
- "example": {
- "dismissal_restrictions": {
- "users": [
- "octocat"
- ],
- "teams": [
- "justice-league"
- ]
- },
- "bypass_pull_request_allowances": {
- "users": [
- "octocat"
- ],
- "teams": [
- "justice-league"
- ]
- },
- "dismiss_stale_reviews": true,
- "require_code_owner_reviews": true,
- "required_approving_review_count": 2
+ "examples": {
+ "default": {
+ "value": {
+ "dismissal_restrictions": {
+ "users": [
+ "octocat"
+ ],
+ "teams": [
+ "justice-league"
+ ]
+ },
+ "bypass_pull_request_allowances": {
+ "users": [
+ "octocat"
+ ],
+ "teams": [
+ "justice-league"
+ ]
+ },
+ "dismiss_stale_reviews": true,
+ "require_code_owner_reviews": true,
+ "required_approving_review_count": 2
+ }
+ }
}
}
}
@@ -163205,11 +163309,15 @@
}
}
},
- "example": {
- "strict": true,
- "contexts": [
- "continuous-integration/travis-ci"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "strict": true,
+ "contexts": [
+ "continuous-integration/travis-ci"
+ ]
+ }
+ }
}
}
}
@@ -169664,8 +169772,12 @@
"new_name"
]
},
- "example": {
- "new_name": "my_renamed_branch"
+ "examples": {
+ "default": {
+ "value": {
+ "new_name": "my_renamed_branch"
+ }
+ }
}
}
}
@@ -182201,13 +182313,17 @@
}
}
},
- "example": {
- "auto_trigger_checks": [
- {
- "app_id": 4,
- "setting": false
+ "examples": {
+ "default": {
+ "value": {
+ "auto_trigger_checks": [
+ {
+ "app_id": 4,
+ "setting": false
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -190449,9 +190565,13 @@
"state"
]
},
- "example": {
- "state": "dismissed",
- "dismissed_reason": "false positive"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "dismissed",
+ "dismissed_reason": "false positive"
+ }
+ }
}
}
}
@@ -197005,8 +197125,12 @@
"body"
]
},
- "example": {
- "body": "Nice change"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Nice change"
+ }
+ }
}
}
}
@@ -197919,7 +198043,7 @@
"content"
]
},
- "example": {
+ "examples": {
"default": {
"value": {
"content": "heart"
@@ -200338,11 +200462,15 @@
"body"
]
},
- "example": {
- "body": "Great stuff",
- "path": "file1.txt",
- "position": 4,
- "line": 1
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Great stuff",
+ "path": "file1.txt",
+ "position": 4,
+ "line": 1
+ }
+ }
}
}
}
@@ -218968,13 +219096,17 @@
"sha"
]
},
- "example": {
- "message": "my commit message",
- "committer": {
- "name": "Monalisa Octocat",
- "email": "octocat@github.com"
- },
- "sha": "329688480d39049927147c162b9d2deaf885005f"
+ "examples": {
+ "default": {
+ "value": {
+ "message": "my commit message",
+ "committer": {
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com"
+ },
+ "sha": "329688480d39049927147c162b9d2deaf885005f"
+ }
+ }
}
}
}
@@ -223094,11 +223226,15 @@
"state"
]
},
- "example": {
- "environment": "production",
- "state": "success",
- "log_url": "https://example.com/deployment/42/output",
- "description": "Deployment finished successfully."
+ "examples": {
+ "default": {
+ "value": {
+ "environment": "production",
+ "state": "success",
+ "log_url": "https://example.com/deployment/42/output",
+ "description": "Deployment finished successfully."
+ }
+ }
}
}
}
@@ -239327,9 +239463,13 @@
"content"
]
},
- "example": {
- "content": "Content of the blob",
- "encoding": "utf-8"
+ "examples": {
+ "default": {
+ "value": {
+ "content": "Content of the blob",
+ "encoding": "utf-8"
+ }
+ }
}
}
}
@@ -240914,9 +241054,13 @@
"sha"
]
},
- "example": {
- "ref": "refs/heads/featureA",
- "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd"
+ "examples": {
+ "default": {
+ "value": {
+ "ref": "refs/heads/featureA",
+ "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd"
+ }
+ }
}
}
}
@@ -241145,9 +241289,13 @@
"sha"
]
},
- "example": {
- "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
- "force": true
+ "examples": {
+ "default": {
+ "value": {
+ "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
+ "force": true
+ }
+ }
}
}
}
@@ -241522,15 +241670,19 @@
"type"
]
},
- "example": {
- "tag": "v0.0.1",
- "message": "initial version",
- "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
- "type": "commit",
- "tagger": {
- "name": "Monalisa Octocat",
- "email": "octocat@github.com",
- "date": "2011-06-17T14:53:35-07:00"
+ "examples": {
+ "default": {
+ "value": {
+ "tag": "v0.0.1",
+ "message": "initial version",
+ "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
+ "type": "commit",
+ "tagger": {
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com",
+ "date": "2011-06-17T14:53:35-07:00"
+ }
+ }
}
}
}
@@ -242099,16 +242251,20 @@
"tree"
]
},
- "example": {
- "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
- "tree": [
- {
- "path": "file.rb",
- "mode": "100644",
- "type": "blob",
- "sha": "44b4fc6d56897b048c772eb4087f854f46256132"
+ "examples": {
+ "default": {
+ "value": {
+ "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
+ "tree": [
+ {
+ "path": "file.rb",
+ "mode": "100644",
+ "type": "blob",
+ "sha": "44b4fc6d56897b048c772eb4087f854f46256132"
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -243167,17 +243323,21 @@
},
"additionalProperties": false
},
- "example": {
- "name": "web",
- "active": true,
- "events": [
- "push",
- "pull_request"
- ],
- "config": {
- "url": "https://example.com/webhook",
- "content_type": "json",
- "insecure_ssl": "0"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "url": "https://example.com/webhook",
+ "content_type": "json",
+ "insecure_ssl": "0"
+ }
+ }
}
}
}
@@ -244015,11 +244175,15 @@
}
}
},
- "example": {
- "active": true,
- "add_events": [
- "pull_request"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "active": true,
+ "add_events": [
+ "pull_request"
+ ]
+ }
+ }
}
}
}
@@ -255872,16 +256036,20 @@
"title"
]
},
- "example": {
- "title": "Found a bug",
- "body": "I'm having a problem with this.",
- "assignees": [
- "octocat"
- ],
- "milestone": 1,
- "labels": [
- "bug"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Found a bug",
+ "body": "I'm having a problem with this.",
+ "assignees": [
+ "octocat"
+ ],
+ "milestone": 1,
+ "labels": [
+ "bug"
+ ]
+ }
+ }
}
}
}
@@ -260939,8 +261107,12 @@
"body"
]
},
- "example": {
- "body": "Me too"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Me too"
+ }
+ }
}
}
}
@@ -279541,11 +279713,15 @@
}
}
},
- "example": {
- "assignees": [
- "hubot",
- "other_user"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "assignees": [
+ "hubot",
+ "other_user"
+ ]
+ }
+ }
}
}
}
@@ -282759,11 +282935,15 @@
}
}
},
- "example": {
- "assignees": [
- "hubot",
- "other_user"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "assignees": [
+ "hubot",
+ "other_user"
+ ]
+ }
+ }
}
}
}
@@ -286806,8 +286986,12 @@
"body"
]
},
- "example": {
- "body": "Me too"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Me too"
+ }
+ }
}
}
}
@@ -298117,11 +298301,15 @@
}
]
},
- "example": {
- "labels": [
- "bug",
- "enhancement"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "labels": [
+ "bug",
+ "enhancement"
+ ]
+ }
+ }
}
}
}
@@ -298440,11 +298628,15 @@
}
]
},
- "example": {
- "labels": [
- "bug",
- "enhancement"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "labels": [
+ "bug",
+ "enhancement"
+ ]
+ }
+ }
}
}
}
@@ -316243,10 +316435,14 @@
"key"
]
},
- "example": {
- "title": "octocat@octomac",
- "key": "ssh-rsa AAA...",
- "read_only": true
+ "examples": {
+ "default": {
+ "value": {
+ "title": "octocat@octomac",
+ "key": "ssh-rsa AAA...",
+ "read_only": true
+ }
+ }
}
}
}
@@ -316827,10 +317023,14 @@
"name"
]
},
- "example": {
- "name": "bug",
- "description": "Something isn't working",
- "color": "f29513"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513"
+ }
+ }
}
}
}
@@ -317257,10 +317457,14 @@
}
}
},
- "example": {
- "new_name": "bug :bug:",
- "description": "Small bug fix required",
- "color": "b01f26"
+ "examples": {
+ "default": {
+ "value": {
+ "new_name": "bug :bug:",
+ "description": "Small bug fix required",
+ "color": "b01f26"
+ }
+ }
}
}
}
@@ -319233,11 +319437,15 @@
"title"
]
},
- "example": {
- "title": "v1.0",
- "state": "open",
- "description": "Tracking milestone for version 1.0",
- "due_on": "2012-10-09T23:39:01Z"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "v1.0",
+ "state": "open",
+ "description": "Tracking milestone for version 1.0",
+ "due_on": "2012-10-09T23:39:01Z"
+ }
+ }
}
}
}
@@ -320214,11 +320422,15 @@
}
}
},
- "example": {
- "title": "v1.0",
- "state": "open",
- "description": "Tracking milestone for version 1.0",
- "due_on": "2012-10-09T23:39:01Z"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "v1.0",
+ "state": "open",
+ "description": "Tracking milestone for version 1.0",
+ "due_on": "2012-10-09T23:39:01Z"
+ }
+ }
}
}
}
@@ -325709,8 +325921,12 @@
}
}
},
- "example": {
- "enforcement": "enabled"
+ "examples": {
+ "default": {
+ "value": {
+ "enforcement": "enabled"
+ }
+ }
}
}
}
@@ -326422,9 +326638,13 @@
"name"
]
},
- "example": {
- "name": "Projects Documentation",
- "body": "Developer documentation project for the developer site."
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Projects Documentation",
+ "body": "Developer documentation project for the developer site."
+ }
+ }
}
}
}
@@ -332605,11 +332825,15 @@
"base"
]
},
- "example": {
- "title": "Amazing new feature",
- "body": "Please pull these awesome changes in!",
- "head": "octocat:new-feature",
- "base": "master"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Amazing new feature",
+ "body": "Please pull these awesome changes in!",
+ "head": "octocat:new-feature",
+ "base": "master"
+ }
+ }
}
}
}
@@ -337861,8 +338085,12 @@
"body"
]
},
- "example": {
- "body": "I like this too!"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "I like this too!"
+ }
+ }
}
}
}
@@ -343564,11 +343792,15 @@
}
}
},
- "example": {
- "title": "new title",
- "body": "updated body",
- "state": "open",
- "base": "master"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "new title",
+ "body": "updated body",
+ "state": "open",
+ "base": "master"
+ }
+ }
}
}
}
@@ -348984,8 +349216,12 @@
"body"
]
},
- "example": {
- "body": "Great stuff!"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Great stuff!"
+ }
+ }
}
}
}
@@ -351669,15 +351905,19 @@
}
]
},
- "example": {
- "reviewers": [
- "octocat",
- "hubot",
- "other_user"
- ],
- "team_reviewers": [
- "justice-league"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "reviewers": [
+ "octocat",
+ "hubot",
+ "other_user"
+ ],
+ "team_reviewers": [
+ "justice-league"
+ ]
+ }
+ }
}
}
}
@@ -362757,17 +362997,21 @@
}
}
},
- "example": {
- "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
- "body": "This is close to perfect! Please address the suggested inline change.",
- "event": "REQUEST_CHANGES",
- "comments": [
- {
- "path": "file.md",
- "position": 6,
- "body": "Please add more information here, and fix this typo."
+ "examples": {
+ "default": {
+ "value": {
+ "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
+ "body": "This is close to perfect! Please address the suggested inline change.",
+ "event": "REQUEST_CHANGES",
+ "comments": [
+ {
+ "path": "file.md",
+ "position": 6,
+ "body": "Please add more information here, and fix this typo."
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -367762,13 +368006,17 @@
"tag_name"
]
},
- "example": {
- "tag_name": "v1.0.0",
- "target_commitish": "master",
- "name": "v1.0.0",
- "body": "Description of the release",
- "draft": false,
- "prerelease": false
+ "examples": {
+ "default": {
+ "value": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "master",
+ "name": "v1.0.0",
+ "body": "Description of the release",
+ "draft": false,
+ "prerelease": false
+ }
+ }
}
}
}
@@ -368976,9 +369224,13 @@
}
}
},
- "example": {
- "name": "foo-1.0.0-osx.zip",
- "label": "Mac binary"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "foo-1.0.0-osx.zip",
+ "label": "Mac binary"
+ }
+ }
}
}
}
@@ -371577,13 +371829,17 @@
}
}
},
- "example": {
- "tag_name": "v1.0.0",
- "target_commitish": "master",
- "name": "v1.0.0",
- "body": "Description of the release",
- "draft": false,
- "prerelease": false
+ "examples": {
+ "default": {
+ "value": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "master",
+ "name": "v1.0.0",
+ "body": "Description of the release",
+ "draft": false,
+ "prerelease": false
+ }
+ }
}
}
}
@@ -375014,9 +375270,13 @@
"state"
]
},
- "example": {
- "state": "resolved",
- "resolution": "false_positive"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "resolved",
+ "resolution": "false_positive"
+ }
+ }
}
}
}
@@ -376778,11 +377038,15 @@
"state"
]
},
- "example": {
- "state": "success",
- "target_url": "https://example.com/build/status",
- "description": "The build succeeded!",
- "context": "continuous-integration/jenkins"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "success",
+ "target_url": "https://example.com/build/status",
+ "description": "The build succeeded!",
+ "context": "continuous-integration/jenkins"
+ }
+ }
}
}
}
@@ -378337,13 +378601,17 @@
"names"
]
},
- "example": {
- "names": [
- "octocat",
- "atom",
- "electron",
- "api"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "names": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ]
+ }
+ }
}
}
}
@@ -378529,12 +378797,16 @@
"new_owner"
]
},
- "example": {
- "new_owner": "github",
- "team_ids": [
- 12,
- 345
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "new_owner": "github",
+ "team_ids": [
+ 12,
+ 345
+ ]
+ }
+ }
}
}
}
@@ -381012,12 +381284,16 @@
"name"
]
},
- "example": {
- "owner": "octocat",
- "name": "Hello-World",
- "description": "This is your first repository",
- "include_all_branches": false,
- "private": false
+ "examples": {
+ "default": {
+ "value": {
+ "owner": "octocat",
+ "name": "Hello-World",
+ "description": "This is your first repository",
+ "include_all_branches": false,
+ "private": false
+ }
+ }
}
}
}
@@ -400228,9 +400504,13 @@
"body"
]
},
- "example": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Our first team post",
+ "body": "Hi! This is an area for us to collaborate as a team."
+ }
+ }
}
}
}
@@ -401175,8 +401455,12 @@
}
}
},
- "example": {
- "title": "Welcome to our first team post"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Welcome to our first team post"
+ }
+ }
}
}
}
@@ -402164,8 +402448,12 @@
"body"
]
},
- "example": {
- "body": "Do you like apples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like apples?"
+ }
+ }
}
}
}
@@ -403037,8 +403325,12 @@
"body"
]
},
- "example": {
- "body": "Do you like pineapples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like pineapples?"
+ }
+ }
}
}
}
@@ -403906,8 +404198,12 @@
"content"
]
},
- "example": {
- "content": "heart"
+ "examples": {
+ "default": {
+ "value": {
+ "content": "heart"
+ }
+ }
}
}
}
@@ -404592,8 +404888,12 @@
"content"
]
},
- "example": {
- "content": "heart"
+ "examples": {
+ "default": {
+ "value": {
+ "content": "heart"
+ }
+ }
}
}
}
@@ -424947,8 +425247,12 @@
"state"
]
},
- "example": {
- "state": "active"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "active"
+ }
+ }
}
}
}
diff --git a/lib/rest/static/dereferenced/ghes-3.3.deref.json b/lib/rest/static/dereferenced/ghes-3.3.deref.json
index 5ccb73c28c56..93e70084f3b9 100644
--- a/lib/rest/static/dereferenced/ghes-3.3.deref.json
+++ b/lib/rest/static/dereferenced/ghes-3.3.deref.json
@@ -668,16 +668,20 @@
"config"
]
},
- "example": {
- "name": "web",
- "events": [
- "organization",
- "user"
- ],
- "config": {
- "url": "https://example.com/webhook",
- "content_type": "json",
- "secret": "secret"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "events": [
+ "organization",
+ "user"
+ ],
+ "config": {
+ "url": "https://example.com/webhook",
+ "content_type": "json",
+ "secret": "secret"
+ }
+ }
}
}
}
@@ -951,12 +955,16 @@
}
}
},
- "example": {
- "events": [
- "organization"
- ],
- "config": {
- "url": "https://example.com/webhook"
+ "examples": {
+ "default": {
+ "value": {
+ "events": [
+ "organization"
+ ],
+ "config": {
+ "url": "https://example.com/webhook"
+ }
+ }
}
}
}
@@ -1393,8 +1401,12 @@
"ldap_dn"
]
},
- "example": {
- "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
+ "examples": {
+ "default": {
+ "value": {
+ "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
+ }
+ }
}
}
}
@@ -1894,8 +1906,12 @@
"ldap_dn"
]
},
- "example": {
- "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
+ "examples": {
+ "default": {
+ "value": {
+ "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
+ }
+ }
}
}
}
@@ -2121,10 +2137,14 @@
"admin"
]
},
- "example": {
- "login": "github",
- "profile_name": "GitHub, Inc.",
- "admin": "monalisaoctocat"
+ "examples": {
+ "default": {
+ "value": {
+ "login": "github",
+ "profile_name": "GitHub, Inc.",
+ "admin": "monalisaoctocat"
+ }
+ }
}
}
}
@@ -2495,9 +2515,13 @@
"image_url"
]
},
- "example": {
- "name": "DevTools Hook Env",
- "image_url": "https://my_file_server/path/to/devtools_env.tar.gz"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "DevTools Hook Env",
+ "image_url": "https://my_file_server/path/to/devtools_env.tar.gz"
+ }
+ }
}
}
}
@@ -3455,16 +3479,20 @@
"environment"
]
},
- "example": {
- "name": "Check Commits",
- "script": "scripts/commit_check.sh",
- "enforcement": "disabled",
- "allow_downstream_configuration": false,
- "script_repository": {
- "full_name": "DevIT/hooks"
- },
- "environment": {
- "id": 2
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Check Commits",
+ "script": "scripts/commit_check.sh",
+ "enforcement": "disabled",
+ "allow_downstream_configuration": false,
+ "script_repository": {
+ "full_name": "DevIT/hooks"
+ },
+ "environment": {
+ "id": 2
+ }
+ }
}
}
}
@@ -3830,12 +3858,16 @@
}
}
},
- "example": {
- "name": "Check Commits",
- "environment": {
- "id": 1
- },
- "allow_downstream_configuration": true
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Check Commits",
+ "environment": {
+ "id": 1
+ },
+ "allow_downstream_configuration": true
+ }
+ }
}
}
}
@@ -4999,9 +5031,13 @@
"login"
]
},
- "example": {
- "login": "monalisa",
- "email": "octocat@github.com"
+ "examples": {
+ "default": {
+ "value": {
+ "login": "monalisa",
+ "email": "octocat@github.com"
+ }
+ }
}
}
}
@@ -28935,17 +28971,21 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected",
- "selected_organization_ids": [
- 32,
- 91
- ],
- "runners": [
- 9,
- 2
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected",
+ "selected_organization_ids": [
+ 32,
+ 91
+ ],
+ "runners": [
+ 9,
+ 2
+ ]
+ }
+ }
}
}
}
@@ -29167,9 +29207,13 @@
}
}
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected"
+ }
+ }
}
}
}
@@ -66107,17 +66151,21 @@
}
}
},
- "example": {
- "billing_email": "mona@github.com",
- "company": "GitHub",
- "email": "mona@github.com",
- "twitter_username": "github",
- "location": "San Francisco",
- "name": "github",
- "description": "GitHub, the company.",
- "default_repository_permission": "read",
- "members_can_create_repositories": true,
- "members_allowed_repository_creation_type": "all"
+ "examples": {
+ "default": {
+ "value": {
+ "billing_email": "mona@github.com",
+ "company": "GitHub",
+ "email": "mona@github.com",
+ "twitter_username": "github",
+ "location": "San Francisco",
+ "name": "github",
+ "description": "GitHub, the company.",
+ "default_repository_permission": "read",
+ "members_can_create_repositories": true,
+ "members_allowed_repository_creation_type": "all"
+ }
+ }
}
}
}
@@ -68908,17 +68956,21 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected",
- "selected_repository_ids": [
- 32,
- 91
- ],
- "runners": [
- 9,
- 2
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected",
+ "selected_repository_ids": [
+ 32,
+ 91
+ ],
+ "runners": [
+ 9,
+ 2
+ ]
+ }
+ }
}
}
}
@@ -69159,9 +69211,13 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected"
+ }
+ }
}
}
}
@@ -83280,16 +83336,20 @@
"config"
]
},
- "example": {
- "name": "web",
- "active": true,
- "events": [
- "push",
- "pull_request"
- ],
- "config": {
- "url": "http://example.com/webhook",
- "content_type": "json"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "url": "http://example.com/webhook",
+ "content_type": "json"
+ }
+ }
}
}
}
@@ -83871,11 +83931,15 @@
}
}
},
- "example": {
- "active": true,
- "events": [
- "pull_request"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "active": true,
+ "events": [
+ "pull_request"
+ ]
+ }
+ }
}
}
}
@@ -93102,9 +93166,13 @@
}
}
},
- "example": {
- "enforcement": "enabled",
- "allow_downstream_configuration": false
+ "examples": {
+ "default": {
+ "value": {
+ "enforcement": "enabled",
+ "allow_downstream_configuration": false
+ }
+ }
}
}
}
@@ -93675,9 +93743,13 @@
"name"
]
},
- "example": {
- "name": "Organization Roadmap",
- "body": "High-level roadmap for the upcoming year."
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Organization Roadmap",
+ "body": "High-level roadmap for the upcoming year."
+ }
+ }
}
}
}
@@ -97016,14 +97088,18 @@
"name"
]
},
- "example": {
- "name": "Hello-World",
- "description": "This is your first repository",
- "homepage": "https://github.com",
- "private": false,
- "has_issues": true,
- "has_projects": true,
- "has_wiki": true
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Hello-World",
+ "description": "This is your first repository",
+ "homepage": "https://github.com",
+ "private": false,
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true
+ }
+ }
}
}
}
@@ -102028,11 +102104,15 @@
"name"
]
},
- "example": {
- "name": "Justice League",
- "description": "A great team",
- "permission": "push",
- "privacy": "closed"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Justice League",
+ "description": "A great team",
+ "permission": "push",
+ "privacy": "closed"
+ }
+ }
}
}
}
@@ -103612,10 +103692,14 @@
}
}
},
- "example": {
- "name": "new team name",
- "description": "new team description",
- "privacy": "closed"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "new team name",
+ "description": "new team description",
+ "privacy": "closed"
+ }
+ }
}
}
}
@@ -104898,9 +104982,13 @@
"body"
]
},
- "example": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Our first team post",
+ "body": "Hi! This is an area for us to collaborate as a team."
+ }
+ }
}
}
}
@@ -105845,8 +105933,12 @@
}
}
},
- "example": {
- "title": "Welcome to our first team post"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Welcome to our first team post"
+ }
+ }
}
}
}
@@ -106840,8 +106932,12 @@
"body"
]
},
- "example": {
- "body": "Do you like apples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like apples?"
+ }
+ }
}
}
}
@@ -107713,8 +107809,12 @@
"body"
]
},
- "example": {
- "body": "Do you like pineapples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like pineapples?"
+ }
+ }
}
}
}
@@ -136134,7 +136234,7 @@
"/repos/{owner}/{repo}/actions/permissions": {
"get": {
"summary": "Get GitHub Actions permissions for a repository",
- "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint. GitHub Apps must have the `administration` repository permission to use this API.",
+ "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.",
"operationId": "actions/get-github-actions-permissions-repository",
"tags": [
"actions"
@@ -159041,9 +159141,13 @@
"url_template"
]
},
- "example": {
- "key_prefix": "TICKET-",
- "url_template": "https://example.com/TICKET?query="
+ "examples": {
+ "default": {
+ "value": {
+ "key_prefix": "TICKET-",
+ "url_template": "https://example.com/TICKET?query="
+ }
+ }
}
}
}
@@ -165442,26 +165546,30 @@
}
}
},
- "example": {
- "dismissal_restrictions": {
- "users": [
- "octocat"
- ],
- "teams": [
- "justice-league"
- ]
- },
- "bypass_pull_request_allowances": {
- "users": [
- "octocat"
- ],
- "teams": [
- "justice-league"
- ]
- },
- "dismiss_stale_reviews": true,
- "require_code_owner_reviews": true,
- "required_approving_review_count": 2
+ "examples": {
+ "default": {
+ "value": {
+ "dismissal_restrictions": {
+ "users": [
+ "octocat"
+ ],
+ "teams": [
+ "justice-league"
+ ]
+ },
+ "bypass_pull_request_allowances": {
+ "users": [
+ "octocat"
+ ],
+ "teams": [
+ "justice-league"
+ ]
+ },
+ "dismiss_stale_reviews": true,
+ "require_code_owner_reviews": true,
+ "required_approving_review_count": 2
+ }
+ }
}
}
}
@@ -166619,11 +166727,15 @@
}
}
},
- "example": {
- "strict": true,
- "contexts": [
- "continuous-integration/travis-ci"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "strict": true,
+ "contexts": [
+ "continuous-integration/travis-ci"
+ ]
+ }
+ }
}
}
}
@@ -173078,8 +173190,12 @@
"new_name"
]
},
- "example": {
- "new_name": "my_renamed_branch"
+ "examples": {
+ "default": {
+ "value": {
+ "new_name": "my_renamed_branch"
+ }
+ }
}
}
}
@@ -185761,13 +185877,17 @@
}
}
},
- "example": {
- "auto_trigger_checks": [
- {
- "app_id": 4,
- "setting": false
+ "examples": {
+ "default": {
+ "value": {
+ "auto_trigger_checks": [
+ {
+ "app_id": 4,
+ "setting": false
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -194007,9 +194127,13 @@
"state"
]
},
- "example": {
- "state": "dismissed",
- "dismissed_reason": "false positive"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "dismissed",
+ "dismissed_reason": "false positive"
+ }
+ }
}
}
}
@@ -200543,8 +200667,12 @@
"body"
]
},
- "example": {
- "body": "Nice change"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Nice change"
+ }
+ }
}
}
}
@@ -201452,7 +201580,7 @@
"content"
]
},
- "example": {
+ "examples": {
"default": {
"value": {
"content": "heart"
@@ -203849,11 +203977,15 @@
"body"
]
},
- "example": {
- "body": "Great stuff",
- "path": "file1.txt",
- "position": 4,
- "line": 1
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Great stuff",
+ "path": "file1.txt",
+ "position": 4,
+ "line": 1
+ }
+ }
}
}
}
@@ -222473,13 +222605,17 @@
"sha"
]
},
- "example": {
- "message": "my commit message",
- "committer": {
- "name": "Monalisa Octocat",
- "email": "octocat@github.com"
- },
- "sha": "329688480d39049927147c162b9d2deaf885005f"
+ "examples": {
+ "default": {
+ "value": {
+ "message": "my commit message",
+ "committer": {
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com"
+ },
+ "sha": "329688480d39049927147c162b9d2deaf885005f"
+ }
+ }
}
}
}
@@ -226567,11 +226703,15 @@
"state"
]
},
- "example": {
- "environment": "production",
- "state": "success",
- "log_url": "https://example.com/deployment/42/output",
- "description": "Deployment finished successfully."
+ "examples": {
+ "default": {
+ "value": {
+ "environment": "production",
+ "state": "success",
+ "log_url": "https://example.com/deployment/42/output",
+ "description": "Deployment finished successfully."
+ }
+ }
}
}
}
@@ -242780,9 +242920,13 @@
"content"
]
},
- "example": {
- "content": "Content of the blob",
- "encoding": "utf-8"
+ "examples": {
+ "default": {
+ "value": {
+ "content": "Content of the blob",
+ "encoding": "utf-8"
+ }
+ }
}
}
}
@@ -244367,9 +244511,13 @@
"sha"
]
},
- "example": {
- "ref": "refs/heads/featureA",
- "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd"
+ "examples": {
+ "default": {
+ "value": {
+ "ref": "refs/heads/featureA",
+ "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd"
+ }
+ }
}
}
}
@@ -244598,9 +244746,13 @@
"sha"
]
},
- "example": {
- "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
- "force": true
+ "examples": {
+ "default": {
+ "value": {
+ "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
+ "force": true
+ }
+ }
}
}
}
@@ -244975,15 +245127,19 @@
"type"
]
},
- "example": {
- "tag": "v0.0.1",
- "message": "initial version",
- "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
- "type": "commit",
- "tagger": {
- "name": "Monalisa Octocat",
- "email": "octocat@github.com",
- "date": "2011-06-17T14:53:35-07:00"
+ "examples": {
+ "default": {
+ "value": {
+ "tag": "v0.0.1",
+ "message": "initial version",
+ "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
+ "type": "commit",
+ "tagger": {
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com",
+ "date": "2011-06-17T14:53:35-07:00"
+ }
+ }
}
}
}
@@ -245552,16 +245708,20 @@
"tree"
]
},
- "example": {
- "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
- "tree": [
- {
- "path": "file.rb",
- "mode": "100644",
- "type": "blob",
- "sha": "44b4fc6d56897b048c772eb4087f854f46256132"
+ "examples": {
+ "default": {
+ "value": {
+ "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
+ "tree": [
+ {
+ "path": "file.rb",
+ "mode": "100644",
+ "type": "blob",
+ "sha": "44b4fc6d56897b048c772eb4087f854f46256132"
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -246620,17 +246780,21 @@
},
"additionalProperties": false
},
- "example": {
- "name": "web",
- "active": true,
- "events": [
- "push",
- "pull_request"
- ],
- "config": {
- "url": "https://example.com/webhook",
- "content_type": "json",
- "insecure_ssl": "0"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "url": "https://example.com/webhook",
+ "content_type": "json",
+ "insecure_ssl": "0"
+ }
+ }
}
}
}
@@ -247468,11 +247632,15 @@
}
}
},
- "example": {
- "active": true,
- "add_events": [
- "pull_request"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "active": true,
+ "add_events": [
+ "pull_request"
+ ]
+ }
+ }
}
}
}
@@ -259316,16 +259484,20 @@
"title"
]
},
- "example": {
- "title": "Found a bug",
- "body": "I'm having a problem with this.",
- "assignees": [
- "octocat"
- ],
- "milestone": 1,
- "labels": [
- "bug"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Found a bug",
+ "body": "I'm having a problem with this.",
+ "assignees": [
+ "octocat"
+ ],
+ "milestone": 1,
+ "labels": [
+ "bug"
+ ]
+ }
+ }
}
}
}
@@ -264367,8 +264539,12 @@
"body"
]
},
- "example": {
- "body": "Me too"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Me too"
+ }
+ }
}
}
}
@@ -282937,11 +283113,15 @@
}
}
},
- "example": {
- "assignees": [
- "hubot",
- "other_user"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "assignees": [
+ "hubot",
+ "other_user"
+ ]
+ }
+ }
}
}
}
@@ -286155,11 +286335,15 @@
}
}
},
- "example": {
- "assignees": [
- "hubot",
- "other_user"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "assignees": [
+ "hubot",
+ "other_user"
+ ]
+ }
+ }
}
}
}
@@ -290196,8 +290380,12 @@
"body"
]
},
- "example": {
- "body": "Me too"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Me too"
+ }
+ }
}
}
}
@@ -301501,11 +301689,15 @@
}
]
},
- "example": {
- "labels": [
- "bug",
- "enhancement"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "labels": [
+ "bug",
+ "enhancement"
+ ]
+ }
+ }
}
}
}
@@ -301824,11 +302016,15 @@
}
]
},
- "example": {
- "labels": [
- "bug",
- "enhancement"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "labels": [
+ "bug",
+ "enhancement"
+ ]
+ }
+ }
}
}
}
@@ -319602,10 +319798,14 @@
"key"
]
},
- "example": {
- "title": "octocat@octomac",
- "key": "ssh-rsa AAA...",
- "read_only": true
+ "examples": {
+ "default": {
+ "value": {
+ "title": "octocat@octomac",
+ "key": "ssh-rsa AAA...",
+ "read_only": true
+ }
+ }
}
}
}
@@ -320186,10 +320386,14 @@
"name"
]
},
- "example": {
- "name": "bug",
- "description": "Something isn't working",
- "color": "f29513"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513"
+ }
+ }
}
}
}
@@ -320616,10 +320820,14 @@
}
}
},
- "example": {
- "new_name": "bug :bug:",
- "description": "Small bug fix required",
- "color": "b01f26"
+ "examples": {
+ "default": {
+ "value": {
+ "new_name": "bug :bug:",
+ "description": "Small bug fix required",
+ "color": "b01f26"
+ }
+ }
}
}
}
@@ -321206,8 +321414,12 @@
"branch"
]
},
- "example": {
- "branch": "main"
+ "examples": {
+ "default": {
+ "value": {
+ "branch": "main"
+ }
+ }
}
}
}
@@ -322791,11 +323003,15 @@
"title"
]
},
- "example": {
- "title": "v1.0",
- "state": "open",
- "description": "Tracking milestone for version 1.0",
- "due_on": "2012-10-09T23:39:01Z"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "v1.0",
+ "state": "open",
+ "description": "Tracking milestone for version 1.0",
+ "due_on": "2012-10-09T23:39:01Z"
+ }
+ }
}
}
}
@@ -323772,11 +323988,15 @@
}
}
},
- "example": {
- "title": "v1.0",
- "state": "open",
- "description": "Tracking milestone for version 1.0",
- "due_on": "2012-10-09T23:39:01Z"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "v1.0",
+ "state": "open",
+ "description": "Tracking milestone for version 1.0",
+ "due_on": "2012-10-09T23:39:01Z"
+ }
+ }
}
}
}
@@ -329243,8 +329463,12 @@
}
}
},
- "example": {
- "enforcement": "enabled"
+ "examples": {
+ "default": {
+ "value": {
+ "enforcement": "enabled"
+ }
+ }
}
}
}
@@ -329939,9 +330163,13 @@
"name"
]
},
- "example": {
- "name": "Projects Documentation",
- "body": "Developer documentation project for the developer site."
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Projects Documentation",
+ "body": "Developer documentation project for the developer site."
+ }
+ }
}
}
}
@@ -336117,11 +336345,15 @@
"base"
]
},
- "example": {
- "title": "Amazing new feature",
- "body": "Please pull these awesome changes in!",
- "head": "octocat:new-feature",
- "base": "master"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Amazing new feature",
+ "body": "Please pull these awesome changes in!",
+ "head": "octocat:new-feature",
+ "base": "master"
+ }
+ }
}
}
}
@@ -341353,8 +341585,12 @@
"body"
]
},
- "example": {
- "body": "I like this too!"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "I like this too!"
+ }
+ }
}
}
}
@@ -347035,11 +347271,15 @@
}
}
},
- "example": {
- "title": "new title",
- "body": "updated body",
- "state": "open",
- "base": "master"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "new title",
+ "body": "updated body",
+ "state": "open",
+ "base": "master"
+ }
+ }
}
}
}
@@ -352439,8 +352679,12 @@
"body"
]
},
- "example": {
- "body": "Great stuff!"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Great stuff!"
+ }
+ }
}
}
}
@@ -355124,15 +355368,19 @@
}
]
},
- "example": {
- "reviewers": [
- "octocat",
- "hubot",
- "other_user"
- ],
- "team_reviewers": [
- "justice-league"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "reviewers": [
+ "octocat",
+ "hubot",
+ "other_user"
+ ],
+ "team_reviewers": [
+ "justice-league"
+ ]
+ }
+ }
}
}
}
@@ -366212,17 +366460,21 @@
}
}
},
- "example": {
- "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
- "body": "This is close to perfect! Please address the suggested inline change.",
- "event": "REQUEST_CHANGES",
- "comments": [
- {
- "path": "file.md",
- "position": 6,
- "body": "Please add more information here, and fix this typo."
+ "examples": {
+ "default": {
+ "value": {
+ "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
+ "body": "This is close to perfect! Please address the suggested inline change.",
+ "event": "REQUEST_CHANGES",
+ "comments": [
+ {
+ "path": "file.md",
+ "position": 6,
+ "body": "Please add more information here, and fix this typo."
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -371217,14 +371469,18 @@
"tag_name"
]
},
- "example": {
- "tag_name": "v1.0.0",
- "target_commitish": "master",
- "name": "v1.0.0",
- "body": "Description of the release",
- "draft": false,
- "prerelease": false,
- "generate_release_notes": false
+ "examples": {
+ "default": {
+ "value": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "master",
+ "name": "v1.0.0",
+ "body": "Description of the release",
+ "draft": false,
+ "prerelease": false,
+ "generate_release_notes": false
+ }
+ }
}
}
}
@@ -372432,9 +372688,13 @@
}
}
},
- "example": {
- "name": "foo-1.0.0-osx.zip",
- "label": "Mac binary"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "foo-1.0.0-osx.zip",
+ "label": "Mac binary"
+ }
+ }
}
}
}
@@ -372844,11 +373104,15 @@
"tag_name"
]
},
- "example": {
- "tag_name": "v1.0.0",
- "target_commitish": "main",
- "previous_tag_name": "v0.9.2",
- "configuration_file_path": ".github/custom_release_config.yml"
+ "examples": {
+ "default": {
+ "value": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "main",
+ "previous_tag_name": "v0.9.2",
+ "configuration_file_path": ".github/custom_release_config.yml"
+ }
+ }
}
}
}
@@ -375173,13 +375437,17 @@
}
}
},
- "example": {
- "tag_name": "v1.0.0",
- "target_commitish": "master",
- "name": "v1.0.0",
- "body": "Description of the release",
- "draft": false,
- "prerelease": false
+ "examples": {
+ "default": {
+ "value": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "master",
+ "name": "v1.0.0",
+ "body": "Description of the release",
+ "draft": false,
+ "prerelease": false
+ }
+ }
}
}
}
@@ -378595,9 +378863,13 @@
"state"
]
},
- "example": {
- "state": "resolved",
- "resolution": "false_positive"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "resolved",
+ "resolution": "false_positive"
+ }
+ }
}
}
}
@@ -380604,11 +380876,15 @@
"state"
]
},
- "example": {
- "state": "success",
- "target_url": "https://example.com/build/status",
- "description": "The build succeeded!",
- "context": "continuous-integration/jenkins"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "success",
+ "target_url": "https://example.com/build/status",
+ "description": "The build succeeded!",
+ "context": "continuous-integration/jenkins"
+ }
+ }
}
}
}
@@ -382136,13 +382412,17 @@
"names"
]
},
- "example": {
- "names": [
- "octocat",
- "atom",
- "electron",
- "api"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "names": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ]
+ }
+ }
}
}
}
@@ -382301,12 +382581,16 @@
"new_owner"
]
},
- "example": {
- "new_owner": "github",
- "team_ids": [
- 12,
- 345
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "new_owner": "github",
+ "team_ids": [
+ 12,
+ 345
+ ]
+ }
+ }
}
}
}
@@ -384784,12 +385068,16 @@
"name"
]
},
- "example": {
- "owner": "octocat",
- "name": "Hello-World",
- "description": "This is your first repository",
- "include_all_branches": false,
- "private": false
+ "examples": {
+ "default": {
+ "value": {
+ "owner": "octocat",
+ "name": "Hello-World",
+ "description": "This is your first repository",
+ "include_all_branches": false,
+ "private": false
+ }
+ }
}
}
}
@@ -403957,9 +404245,13 @@
"body"
]
},
- "example": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Our first team post",
+ "body": "Hi! This is an area for us to collaborate as a team."
+ }
+ }
}
}
}
@@ -404892,8 +405184,12 @@
}
}
},
- "example": {
- "title": "Welcome to our first team post"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Welcome to our first team post"
+ }
+ }
}
}
}
@@ -405869,8 +406165,12 @@
"body"
]
},
- "example": {
- "body": "Do you like apples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like apples?"
+ }
+ }
}
}
}
@@ -406730,8 +407030,12 @@
"body"
]
},
- "example": {
- "body": "Do you like pineapples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like pineapples?"
+ }
+ }
}
}
}
@@ -407588,8 +407892,12 @@
"content"
]
},
- "example": {
- "content": "heart"
+ "examples": {
+ "default": {
+ "value": {
+ "content": "heart"
+ }
+ }
}
}
}
@@ -408264,8 +408572,12 @@
"content"
]
},
- "example": {
- "content": "heart"
+ "examples": {
+ "default": {
+ "value": {
+ "content": "heart"
+ }
+ }
}
}
}
@@ -428584,8 +428896,12 @@
"state"
]
},
- "example": {
- "state": "active"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "active"
+ }
+ }
}
}
}
diff --git a/lib/rest/static/dereferenced/ghes-3.4.deref.json b/lib/rest/static/dereferenced/ghes-3.4.deref.json
index baa959fd8990..2619befa06fb 100644
--- a/lib/rest/static/dereferenced/ghes-3.4.deref.json
+++ b/lib/rest/static/dereferenced/ghes-3.4.deref.json
@@ -668,16 +668,20 @@
"config"
]
},
- "example": {
- "name": "web",
- "events": [
- "organization",
- "user"
- ],
- "config": {
- "url": "https://example.com/webhook",
- "content_type": "json",
- "secret": "secret"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "events": [
+ "organization",
+ "user"
+ ],
+ "config": {
+ "url": "https://example.com/webhook",
+ "content_type": "json",
+ "secret": "secret"
+ }
+ }
}
}
}
@@ -951,12 +955,16 @@
}
}
},
- "example": {
- "events": [
- "organization"
- ],
- "config": {
- "url": "https://example.com/webhook"
+ "examples": {
+ "default": {
+ "value": {
+ "events": [
+ "organization"
+ ],
+ "config": {
+ "url": "https://example.com/webhook"
+ }
+ }
}
}
}
@@ -1393,8 +1401,12 @@
"ldap_dn"
]
},
- "example": {
- "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
+ "examples": {
+ "default": {
+ "value": {
+ "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"
+ }
+ }
}
}
}
@@ -1894,8 +1906,12 @@
"ldap_dn"
]
},
- "example": {
- "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
+ "examples": {
+ "default": {
+ "value": {
+ "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"
+ }
+ }
}
}
}
@@ -2121,10 +2137,14 @@
"admin"
]
},
- "example": {
- "login": "github",
- "profile_name": "GitHub, Inc.",
- "admin": "monalisaoctocat"
+ "examples": {
+ "default": {
+ "value": {
+ "login": "github",
+ "profile_name": "GitHub, Inc.",
+ "admin": "monalisaoctocat"
+ }
+ }
}
}
}
@@ -2495,9 +2515,13 @@
"image_url"
]
},
- "example": {
- "name": "DevTools Hook Env",
- "image_url": "https://my_file_server/path/to/devtools_env.tar.gz"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "DevTools Hook Env",
+ "image_url": "https://my_file_server/path/to/devtools_env.tar.gz"
+ }
+ }
}
}
}
@@ -3455,16 +3479,20 @@
"environment"
]
},
- "example": {
- "name": "Check Commits",
- "script": "scripts/commit_check.sh",
- "enforcement": "disabled",
- "allow_downstream_configuration": false,
- "script_repository": {
- "full_name": "DevIT/hooks"
- },
- "environment": {
- "id": 2
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Check Commits",
+ "script": "scripts/commit_check.sh",
+ "enforcement": "disabled",
+ "allow_downstream_configuration": false,
+ "script_repository": {
+ "full_name": "DevIT/hooks"
+ },
+ "environment": {
+ "id": 2
+ }
+ }
}
}
}
@@ -3830,12 +3858,16 @@
}
}
},
- "example": {
- "name": "Check Commits",
- "environment": {
- "id": 1
- },
- "allow_downstream_configuration": true
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Check Commits",
+ "environment": {
+ "id": 1
+ },
+ "allow_downstream_configuration": true
+ }
+ }
}
}
}
@@ -4991,9 +5023,13 @@
"login"
]
},
- "example": {
- "login": "monalisa",
- "email": "octocat@github.com"
+ "examples": {
+ "default": {
+ "value": {
+ "login": "monalisa",
+ "email": "octocat@github.com"
+ }
+ }
}
}
}
@@ -26938,17 +26974,21 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected",
- "selected_organization_ids": [
- 32,
- 91
- ],
- "runners": [
- 9,
- 2
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected",
+ "selected_organization_ids": [
+ 32,
+ 91
+ ],
+ "runners": [
+ 9,
+ 2
+ ]
+ }
+ }
}
}
}
@@ -27170,9 +27210,13 @@
}
}
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected"
+ }
+ }
}
}
}
@@ -68304,17 +68348,21 @@
}
}
},
- "example": {
- "billing_email": "mona@github.com",
- "company": "GitHub",
- "email": "mona@github.com",
- "twitter_username": "github",
- "location": "San Francisco",
- "name": "github",
- "description": "GitHub, the company.",
- "default_repository_permission": "read",
- "members_can_create_repositories": true,
- "members_allowed_repository_creation_type": "all"
+ "examples": {
+ "default": {
+ "value": {
+ "billing_email": "mona@github.com",
+ "company": "GitHub",
+ "email": "mona@github.com",
+ "twitter_username": "github",
+ "location": "San Francisco",
+ "name": "github",
+ "description": "GitHub, the company.",
+ "default_repository_permission": "read",
+ "members_can_create_repositories": true,
+ "members_allowed_repository_creation_type": "all"
+ }
+ }
}
}
}
@@ -71115,17 +71163,21 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected",
- "selected_repository_ids": [
- 32,
- 91
- ],
- "runners": [
- 9,
- 2
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected",
+ "selected_repository_ids": [
+ 32,
+ 91
+ ],
+ "runners": [
+ 9,
+ 2
+ ]
+ }
+ }
}
}
}
@@ -71366,9 +71418,13 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected"
+ }
+ }
}
}
}
@@ -89283,16 +89339,20 @@
"config"
]
},
- "example": {
- "name": "web",
- "active": true,
- "events": [
- "push",
- "pull_request"
- ],
- "config": {
- "url": "http://example.com/webhook",
- "content_type": "json"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "url": "http://example.com/webhook",
+ "content_type": "json"
+ }
+ }
}
}
}
@@ -89874,11 +89934,15 @@
}
}
},
- "example": {
- "active": true,
- "events": [
- "pull_request"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "active": true,
+ "events": [
+ "pull_request"
+ ]
+ }
+ }
}
}
}
@@ -100345,11 +100409,15 @@
"repositories"
]
},
- "example": {
- "repositories": [
- "github/Hello-World"
- ],
- "lock_repositories": true
+ "examples": {
+ "default": {
+ "value": {
+ "repositories": [
+ "github/Hello-World"
+ ],
+ "lock_repositories": true
+ }
+ }
}
}
}
@@ -104861,9 +104929,13 @@
}
}
},
- "example": {
- "enforcement": "enabled",
- "allow_downstream_configuration": false
+ "examples": {
+ "default": {
+ "value": {
+ "enforcement": "enabled",
+ "allow_downstream_configuration": false
+ }
+ }
}
}
}
@@ -105434,9 +105506,13 @@
"name"
]
},
- "example": {
- "name": "Organization Roadmap",
- "body": "High-level roadmap for the upcoming year."
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Organization Roadmap",
+ "body": "High-level roadmap for the upcoming year."
+ }
+ }
}
}
}
@@ -108775,14 +108851,18 @@
"name"
]
},
- "example": {
- "name": "Hello-World",
- "description": "This is your first repository",
- "homepage": "https://github.com",
- "private": false,
- "has_issues": true,
- "has_projects": true,
- "has_wiki": true
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Hello-World",
+ "description": "This is your first repository",
+ "homepage": "https://github.com",
+ "private": false,
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true
+ }
+ }
}
}
}
@@ -113963,11 +114043,15 @@
"name"
]
},
- "example": {
- "name": "Justice League",
- "description": "A great team",
- "permission": "push",
- "privacy": "closed"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Justice League",
+ "description": "A great team",
+ "permission": "push",
+ "privacy": "closed"
+ }
+ }
}
}
}
@@ -115565,10 +115649,14 @@
}
}
},
- "example": {
- "name": "new team name",
- "description": "new team description",
- "privacy": "closed"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "new team name",
+ "description": "new team description",
+ "privacy": "closed"
+ }
+ }
}
}
}
@@ -116860,9 +116948,13 @@
"body"
]
},
- "example": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Our first team post",
+ "body": "Hi! This is an area for us to collaborate as a team."
+ }
+ }
}
}
}
@@ -117807,8 +117899,12 @@
}
}
},
- "example": {
- "title": "Welcome to our first team post"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Welcome to our first team post"
+ }
+ }
}
}
}
@@ -118802,8 +118898,12 @@
"body"
]
},
- "example": {
- "body": "Do you like apples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like apples?"
+ }
+ }
}
}
}
@@ -119675,8 +119775,12 @@
"body"
]
},
- "example": {
- "body": "Do you like pineapples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like pineapples?"
+ }
+ }
}
}
}
@@ -148096,7 +148200,7 @@
"/repos/{owner}/{repo}/actions/permissions": {
"get": {
"summary": "Get GitHub Actions permissions for a repository",
- "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint. GitHub Apps must have the `administration` repository permission to use this API.",
+ "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.",
"operationId": "actions/get-github-actions-permissions-repository",
"tags": [
"actions"
@@ -171911,9 +172015,13 @@
"url_template"
]
},
- "example": {
- "key_prefix": "TICKET-",
- "url_template": "https://example.com/TICKET?query="
+ "examples": {
+ "default": {
+ "value": {
+ "key_prefix": "TICKET-",
+ "url_template": "https://example.com/TICKET?query="
+ }
+ }
}
}
}
@@ -180312,26 +180420,30 @@
}
}
},
- "example": {
- "dismissal_restrictions": {
- "users": [
- "octocat"
- ],
- "teams": [
- "justice-league"
- ]
- },
- "bypass_pull_request_allowances": {
- "users": [
- "octocat"
- ],
- "teams": [
- "justice-league"
- ]
- },
- "dismiss_stale_reviews": true,
- "require_code_owner_reviews": true,
- "required_approving_review_count": 2
+ "examples": {
+ "default": {
+ "value": {
+ "dismissal_restrictions": {
+ "users": [
+ "octocat"
+ ],
+ "teams": [
+ "justice-league"
+ ]
+ },
+ "bypass_pull_request_allowances": {
+ "users": [
+ "octocat"
+ ],
+ "teams": [
+ "justice-league"
+ ]
+ },
+ "dismiss_stale_reviews": true,
+ "require_code_owner_reviews": true,
+ "required_approving_review_count": 2
+ }
+ }
}
}
}
@@ -181909,11 +182021,15 @@
}
}
},
- "example": {
- "strict": true,
- "contexts": [
- "continuous-integration/travis-ci"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "strict": true,
+ "contexts": [
+ "continuous-integration/travis-ci"
+ ]
+ }
+ }
}
}
}
@@ -188393,8 +188509,12 @@
"new_name"
]
},
- "example": {
- "new_name": "my_renamed_branch"
+ "examples": {
+ "default": {
+ "value": {
+ "new_name": "my_renamed_branch"
+ }
+ }
}
}
}
@@ -201467,13 +201587,17 @@
}
}
},
- "example": {
- "auto_trigger_checks": [
- {
- "app_id": 4,
- "setting": false
+ "examples": {
+ "default": {
+ "value": {
+ "auto_trigger_checks": [
+ {
+ "app_id": 4,
+ "setting": false
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -209799,9 +209923,13 @@
"state"
]
},
- "example": {
- "state": "dismissed",
- "dismissed_reason": "false positive"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "dismissed",
+ "dismissed_reason": "false positive"
+ }
+ }
}
}
}
@@ -216365,8 +216493,12 @@
"body"
]
},
- "example": {
- "body": "Nice change"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Nice change"
+ }
+ }
}
}
}
@@ -217274,7 +217406,7 @@
"content"
]
},
- "example": {
+ "examples": {
"default": {
"value": {
"content": "heart"
@@ -219671,11 +219803,15 @@
"body"
]
},
- "example": {
- "body": "Great stuff",
- "path": "file1.txt",
- "position": 4,
- "line": 1
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Great stuff",
+ "path": "file1.txt",
+ "position": 4,
+ "line": 1
+ }
+ }
}
}
}
@@ -237970,13 +238106,17 @@
"sha"
]
},
- "example": {
- "message": "my commit message",
- "committer": {
- "name": "Monalisa Octocat",
- "email": "octocat@github.com"
- },
- "sha": "329688480d39049927147c162b9d2deaf885005f"
+ "examples": {
+ "default": {
+ "value": {
+ "message": "my commit message",
+ "committer": {
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com"
+ },
+ "sha": "329688480d39049927147c162b9d2deaf885005f"
+ }
+ }
}
}
}
@@ -242508,11 +242648,15 @@
"state"
]
},
- "example": {
- "environment": "production",
- "state": "success",
- "log_url": "https://example.com/deployment/42/output",
- "description": "Deployment finished successfully."
+ "examples": {
+ "default": {
+ "value": {
+ "environment": "production",
+ "state": "success",
+ "log_url": "https://example.com/deployment/42/output",
+ "description": "Deployment finished successfully."
+ }
+ }
}
}
}
@@ -258721,9 +258865,13 @@
"content"
]
},
- "example": {
- "content": "Content of the blob",
- "encoding": "utf-8"
+ "examples": {
+ "default": {
+ "value": {
+ "content": "Content of the blob",
+ "encoding": "utf-8"
+ }
+ }
}
}
}
@@ -260308,9 +260456,13 @@
"sha"
]
},
- "example": {
- "ref": "refs/heads/featureA",
- "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd"
+ "examples": {
+ "default": {
+ "value": {
+ "ref": "refs/heads/featureA",
+ "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd"
+ }
+ }
}
}
}
@@ -260539,9 +260691,13 @@
"sha"
]
},
- "example": {
- "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
- "force": true
+ "examples": {
+ "default": {
+ "value": {
+ "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
+ "force": true
+ }
+ }
}
}
}
@@ -260916,15 +261072,19 @@
"type"
]
},
- "example": {
- "tag": "v0.0.1",
- "message": "initial version",
- "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
- "type": "commit",
- "tagger": {
- "name": "Monalisa Octocat",
- "email": "octocat@github.com",
- "date": "2011-06-17T14:53:35-07:00"
+ "examples": {
+ "default": {
+ "value": {
+ "tag": "v0.0.1",
+ "message": "initial version",
+ "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
+ "type": "commit",
+ "tagger": {
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com",
+ "date": "2011-06-17T14:53:35-07:00"
+ }
+ }
}
}
}
@@ -261493,16 +261653,20 @@
"tree"
]
},
- "example": {
- "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
- "tree": [
- {
- "path": "file.rb",
- "mode": "100644",
- "type": "blob",
- "sha": "44b4fc6d56897b048c772eb4087f854f46256132"
+ "examples": {
+ "default": {
+ "value": {
+ "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
+ "tree": [
+ {
+ "path": "file.rb",
+ "mode": "100644",
+ "type": "blob",
+ "sha": "44b4fc6d56897b048c772eb4087f854f46256132"
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -262561,17 +262725,21 @@
},
"additionalProperties": false
},
- "example": {
- "name": "web",
- "active": true,
- "events": [
- "push",
- "pull_request"
- ],
- "config": {
- "url": "https://example.com/webhook",
- "content_type": "json",
- "insecure_ssl": "0"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "url": "https://example.com/webhook",
+ "content_type": "json",
+ "insecure_ssl": "0"
+ }
+ }
}
}
}
@@ -263409,11 +263577,15 @@
}
}
},
- "example": {
- "active": true,
- "add_events": [
- "pull_request"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "active": true,
+ "add_events": [
+ "pull_request"
+ ]
+ }
+ }
}
}
}
@@ -275249,16 +275421,20 @@
"title"
]
},
- "example": {
- "title": "Found a bug",
- "body": "I'm having a problem with this.",
- "assignees": [
- "octocat"
- ],
- "milestone": 1,
- "labels": [
- "bug"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Found a bug",
+ "body": "I'm having a problem with this.",
+ "assignees": [
+ "octocat"
+ ],
+ "milestone": 1,
+ "labels": [
+ "bug"
+ ]
+ }
+ }
}
}
}
@@ -280300,8 +280476,12 @@
"body"
]
},
- "example": {
- "body": "Me too"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Me too"
+ }
+ }
}
}
}
@@ -298870,11 +299050,15 @@
}
}
},
- "example": {
- "assignees": [
- "hubot",
- "other_user"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "assignees": [
+ "hubot",
+ "other_user"
+ ]
+ }
+ }
}
}
}
@@ -302088,11 +302272,15 @@
}
}
},
- "example": {
- "assignees": [
- "hubot",
- "other_user"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "assignees": [
+ "hubot",
+ "other_user"
+ ]
+ }
+ }
}
}
}
@@ -306129,8 +306317,12 @@
"body"
]
},
- "example": {
- "body": "Me too"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Me too"
+ }
+ }
}
}
}
@@ -317434,11 +317626,15 @@
}
]
},
- "example": {
- "labels": [
- "bug",
- "enhancement"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "labels": [
+ "bug",
+ "enhancement"
+ ]
+ }
+ }
}
}
}
@@ -317757,11 +317953,15 @@
}
]
},
- "example": {
- "labels": [
- "bug",
- "enhancement"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "labels": [
+ "bug",
+ "enhancement"
+ ]
+ }
+ }
}
}
}
@@ -335535,10 +335735,14 @@
"key"
]
},
- "example": {
- "title": "octocat@octomac",
- "key": "ssh-rsa AAA...",
- "read_only": true
+ "examples": {
+ "default": {
+ "value": {
+ "title": "octocat@octomac",
+ "key": "ssh-rsa AAA...",
+ "read_only": true
+ }
+ }
}
}
}
@@ -336119,10 +336323,14 @@
"name"
]
},
- "example": {
- "name": "bug",
- "description": "Something isn't working",
- "color": "f29513"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513"
+ }
+ }
}
}
}
@@ -336549,10 +336757,14 @@
}
}
},
- "example": {
- "new_name": "bug :bug:",
- "description": "Small bug fix required",
- "color": "b01f26"
+ "examples": {
+ "default": {
+ "value": {
+ "new_name": "bug :bug:",
+ "description": "Small bug fix required",
+ "color": "b01f26"
+ }
+ }
}
}
}
@@ -337139,8 +337351,12 @@
"branch"
]
},
- "example": {
- "branch": "main"
+ "examples": {
+ "default": {
+ "value": {
+ "branch": "main"
+ }
+ }
}
}
}
@@ -338724,11 +338940,15 @@
"title"
]
},
- "example": {
- "title": "v1.0",
- "state": "open",
- "description": "Tracking milestone for version 1.0",
- "due_on": "2012-10-09T23:39:01Z"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "v1.0",
+ "state": "open",
+ "description": "Tracking milestone for version 1.0",
+ "due_on": "2012-10-09T23:39:01Z"
+ }
+ }
}
}
}
@@ -339705,11 +339925,15 @@
}
}
},
- "example": {
- "title": "v1.0",
- "state": "open",
- "description": "Tracking milestone for version 1.0",
- "due_on": "2012-10-09T23:39:01Z"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "v1.0",
+ "state": "open",
+ "description": "Tracking milestone for version 1.0",
+ "due_on": "2012-10-09T23:39:01Z"
+ }
+ }
}
}
}
@@ -345176,8 +345400,12 @@
}
}
},
- "example": {
- "enforcement": "enabled"
+ "examples": {
+ "default": {
+ "value": {
+ "enforcement": "enabled"
+ }
+ }
}
}
}
@@ -345872,9 +346100,13 @@
"name"
]
},
- "example": {
- "name": "Projects Documentation",
- "body": "Developer documentation project for the developer site."
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Projects Documentation",
+ "body": "Developer documentation project for the developer site."
+ }
+ }
}
}
}
@@ -352050,11 +352282,15 @@
"base"
]
},
- "example": {
- "title": "Amazing new feature",
- "body": "Please pull these awesome changes in!",
- "head": "octocat:new-feature",
- "base": "master"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Amazing new feature",
+ "body": "Please pull these awesome changes in!",
+ "head": "octocat:new-feature",
+ "base": "master"
+ }
+ }
}
}
}
@@ -357286,8 +357522,12 @@
"body"
]
},
- "example": {
- "body": "I like this too!"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "I like this too!"
+ }
+ }
}
}
}
@@ -362968,11 +363208,15 @@
}
}
},
- "example": {
- "title": "new title",
- "body": "updated body",
- "state": "open",
- "base": "master"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "new title",
+ "body": "updated body",
+ "state": "open",
+ "base": "master"
+ }
+ }
}
}
}
@@ -368372,8 +368616,12 @@
"body"
]
},
- "example": {
- "body": "Great stuff!"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Great stuff!"
+ }
+ }
}
}
}
@@ -371057,15 +371305,19 @@
}
]
},
- "example": {
- "reviewers": [
- "octocat",
- "hubot",
- "other_user"
- ],
- "team_reviewers": [
- "justice-league"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "reviewers": [
+ "octocat",
+ "hubot",
+ "other_user"
+ ],
+ "team_reviewers": [
+ "justice-league"
+ ]
+ }
+ }
}
}
}
@@ -382145,17 +382397,21 @@
}
}
},
- "example": {
- "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
- "body": "This is close to perfect! Please address the suggested inline change.",
- "event": "REQUEST_CHANGES",
- "comments": [
- {
- "path": "file.md",
- "position": 6,
- "body": "Please add more information here, and fix this typo."
+ "examples": {
+ "default": {
+ "value": {
+ "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
+ "body": "This is close to perfect! Please address the suggested inline change.",
+ "event": "REQUEST_CHANGES",
+ "comments": [
+ {
+ "path": "file.md",
+ "position": 6,
+ "body": "Please add more information here, and fix this typo."
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -387150,14 +387406,18 @@
"tag_name"
]
},
- "example": {
- "tag_name": "v1.0.0",
- "target_commitish": "master",
- "name": "v1.0.0",
- "body": "Description of the release",
- "draft": false,
- "prerelease": false,
- "generate_release_notes": false
+ "examples": {
+ "default": {
+ "value": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "master",
+ "name": "v1.0.0",
+ "body": "Description of the release",
+ "draft": false,
+ "prerelease": false,
+ "generate_release_notes": false
+ }
+ }
}
}
}
@@ -388365,9 +388625,13 @@
}
}
},
- "example": {
- "name": "foo-1.0.0-osx.zip",
- "label": "Mac binary"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "foo-1.0.0-osx.zip",
+ "label": "Mac binary"
+ }
+ }
}
}
}
@@ -388777,11 +389041,15 @@
"tag_name"
]
},
- "example": {
- "tag_name": "v1.0.0",
- "target_commitish": "main",
- "previous_tag_name": "v0.9.2",
- "configuration_file_path": ".github/custom_release_config.yml"
+ "examples": {
+ "default": {
+ "value": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "main",
+ "previous_tag_name": "v0.9.2",
+ "configuration_file_path": ".github/custom_release_config.yml"
+ }
+ }
}
}
}
@@ -391106,13 +391374,17 @@
}
}
},
- "example": {
- "tag_name": "v1.0.0",
- "target_commitish": "master",
- "name": "v1.0.0",
- "body": "Description of the release",
- "draft": false,
- "prerelease": false
+ "examples": {
+ "default": {
+ "value": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "master",
+ "name": "v1.0.0",
+ "body": "Description of the release",
+ "draft": false,
+ "prerelease": false
+ }
+ }
}
}
}
@@ -394725,9 +394997,13 @@
"state"
]
},
- "example": {
- "state": "resolved",
- "resolution": "false_positive"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "resolved",
+ "resolution": "false_positive"
+ }
+ }
}
}
}
@@ -396734,11 +397010,15 @@
"state"
]
},
- "example": {
- "state": "success",
- "target_url": "https://example.com/build/status",
- "description": "The build succeeded!",
- "context": "continuous-integration/jenkins"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "success",
+ "target_url": "https://example.com/build/status",
+ "description": "The build succeeded!",
+ "context": "continuous-integration/jenkins"
+ }
+ }
}
}
}
@@ -398266,13 +398546,17 @@
"names"
]
},
- "example": {
- "names": [
- "octocat",
- "atom",
- "electron",
- "api"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "names": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ]
+ }
+ }
}
}
}
@@ -398431,12 +398715,16 @@
"new_owner"
]
},
- "example": {
- "new_owner": "github",
- "team_ids": [
- 12,
- 345
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "new_owner": "github",
+ "team_ids": [
+ 12,
+ 345
+ ]
+ }
+ }
}
}
}
@@ -400914,12 +401202,16 @@
"name"
]
},
- "example": {
- "owner": "octocat",
- "name": "Hello-World",
- "description": "This is your first repository",
- "include_all_branches": false,
- "private": false
+ "examples": {
+ "default": {
+ "value": {
+ "owner": "octocat",
+ "name": "Hello-World",
+ "description": "This is your first repository",
+ "include_all_branches": false,
+ "private": false
+ }
+ }
}
}
}
@@ -420114,9 +420406,13 @@
"body"
]
},
- "example": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Our first team post",
+ "body": "Hi! This is an area for us to collaborate as a team."
+ }
+ }
}
}
}
@@ -421049,8 +421345,12 @@
}
}
},
- "example": {
- "title": "Welcome to our first team post"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Welcome to our first team post"
+ }
+ }
}
}
}
@@ -422026,8 +422326,12 @@
"body"
]
},
- "example": {
- "body": "Do you like apples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like apples?"
+ }
+ }
}
}
}
@@ -422887,8 +423191,12 @@
"body"
]
},
- "example": {
- "body": "Do you like pineapples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like pineapples?"
+ }
+ }
}
}
}
@@ -423745,8 +424053,12 @@
"content"
]
},
- "example": {
- "content": "heart"
+ "examples": {
+ "default": {
+ "value": {
+ "content": "heart"
+ }
+ }
}
}
}
@@ -424421,8 +424733,12 @@
"content"
]
},
- "example": {
- "content": "heart"
+ "examples": {
+ "default": {
+ "value": {
+ "content": "heart"
+ }
+ }
}
}
}
@@ -444733,8 +445049,12 @@
"state"
]
},
- "example": {
- "state": "active"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "active"
+ }
+ }
}
}
}
diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json
index 63f58d34f44c..010668f0d6c5 100644
--- a/lib/rest/static/dereferenced/github.ae.deref.json
+++ b/lib/rest/static/dereferenced/github.ae.deref.json
@@ -664,16 +664,20 @@
"config"
]
},
- "example": {
- "name": "web",
- "events": [
- "organization",
- "user"
- ],
- "config": {
- "url": "https://example.com/webhook",
- "content_type": "json",
- "secret": "secret"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "events": [
+ "organization",
+ "user"
+ ],
+ "config": {
+ "url": "https://example.com/webhook",
+ "content_type": "json",
+ "secret": "secret"
+ }
+ }
}
}
}
@@ -947,12 +951,16 @@
}
}
},
- "example": {
- "events": [
- "organization"
- ],
- "config": {
- "url": "https://example.com/webhook"
+ "examples": {
+ "default": {
+ "value": {
+ "events": [
+ "organization"
+ ],
+ "config": {
+ "url": "https://example.com/webhook"
+ }
+ }
}
}
}
@@ -1437,10 +1445,14 @@
"admin"
]
},
- "example": {
- "login": "github",
- "profile_name": "GitHub, Inc.",
- "admin": "monalisaoctocat"
+ "examples": {
+ "default": {
+ "value": {
+ "login": "github",
+ "profile_name": "GitHub, Inc.",
+ "admin": "monalisaoctocat"
+ }
+ }
}
}
}
@@ -1811,9 +1823,13 @@
"image_url"
]
},
- "example": {
- "name": "DevTools Hook Env",
- "image_url": "https://my_file_server/path/to/devtools_env.tar.gz"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "DevTools Hook Env",
+ "image_url": "https://my_file_server/path/to/devtools_env.tar.gz"
+ }
+ }
}
}
}
@@ -16329,17 +16345,21 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected",
- "selected_organization_ids": [
- 32,
- 91
- ],
- "runners": [
- 9,
- 2
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected",
+ "selected_organization_ids": [
+ 32,
+ 91
+ ],
+ "runners": [
+ 9,
+ 2
+ ]
+ }
+ }
}
}
}
@@ -16561,9 +16581,13 @@
}
}
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected"
+ }
+ }
}
}
}
@@ -45033,17 +45057,21 @@
}
}
},
- "example": {
- "billing_email": "mona@github.com",
- "company": "GitHub",
- "email": "mona@github.com",
- "twitter_username": "github",
- "location": "San Francisco",
- "name": "github",
- "description": "GitHub, the company.",
- "default_repository_permission": "read",
- "members_can_create_repositories": true,
- "members_allowed_repository_creation_type": "all"
+ "examples": {
+ "default": {
+ "value": {
+ "billing_email": "mona@github.com",
+ "company": "GitHub",
+ "email": "mona@github.com",
+ "twitter_username": "github",
+ "location": "San Francisco",
+ "name": "github",
+ "description": "GitHub, the company.",
+ "default_repository_permission": "read",
+ "members_can_create_repositories": true,
+ "members_allowed_repository_creation_type": "all"
+ }
+ }
}
}
}
@@ -47844,17 +47872,21 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected",
- "selected_repository_ids": [
- 32,
- 91
- ],
- "runners": [
- 9,
- 2
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected",
+ "selected_repository_ids": [
+ 32,
+ 91
+ ],
+ "runners": [
+ 9,
+ 2
+ ]
+ }
+ }
}
}
}
@@ -48095,9 +48127,13 @@
"name"
]
},
- "example": {
- "name": "Expensive hardware runners",
- "visibility": "selected"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Expensive hardware runners",
+ "visibility": "selected"
+ }
+ }
}
}
}
@@ -55366,16 +55402,20 @@
"config"
]
},
- "example": {
- "name": "web",
- "active": true,
- "events": [
- "push",
- "pull_request"
- ],
- "config": {
- "url": "http://example.com/webhook",
- "content_type": "json"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "url": "http://example.com/webhook",
+ "content_type": "json"
+ }
+ }
}
}
}
@@ -55957,11 +55997,15 @@
}
}
},
- "example": {
- "active": true,
- "events": [
- "pull_request"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "active": true,
+ "events": [
+ "pull_request"
+ ]
+ }
+ }
}
}
}
@@ -66427,11 +66471,15 @@
"repositories"
]
},
- "example": {
- "repositories": [
- "github/Hello-World"
- ],
- "lock_repositories": true
+ "examples": {
+ "default": {
+ "value": {
+ "repositories": [
+ "github/Hello-World"
+ ],
+ "lock_repositories": true
+ }
+ }
}
}
}
@@ -71138,9 +71186,13 @@
"name"
]
},
- "example": {
- "name": "Organization Roadmap",
- "body": "High-level roadmap for the upcoming year."
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Organization Roadmap",
+ "body": "High-level roadmap for the upcoming year."
+ }
+ }
}
}
}
@@ -74070,14 +74122,18 @@
"name"
]
},
- "example": {
- "name": "Hello-World",
- "description": "This is your first repository",
- "homepage": "https://github.com",
- "private": false,
- "has_issues": true,
- "has_projects": true,
- "has_wiki": true
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Hello-World",
+ "description": "This is your first repository",
+ "homepage": "https://github.com",
+ "private": false,
+ "has_issues": true,
+ "has_projects": true,
+ "has_wiki": true
+ }
+ }
}
}
}
@@ -76091,11 +76147,15 @@
"name"
]
},
- "example": {
- "name": "Justice League",
- "description": "A great team",
- "permission": "push",
- "privacy": "closed"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Justice League",
+ "description": "A great team",
+ "permission": "push",
+ "privacy": "closed"
+ }
+ }
}
}
}
@@ -77695,10 +77755,14 @@
}
}
},
- "example": {
- "name": "new team name",
- "description": "new team description",
- "privacy": "closed"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "new team name",
+ "description": "new team description",
+ "privacy": "closed"
+ }
+ }
}
}
}
@@ -78991,9 +79055,13 @@
"body"
]
},
- "example": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Our first team post",
+ "body": "Hi! This is an area for us to collaborate as a team."
+ }
+ }
}
}
}
@@ -79938,8 +80006,12 @@
}
}
},
- "example": {
- "title": "Welcome to our first team post"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Welcome to our first team post"
+ }
+ }
}
}
}
@@ -80933,8 +81005,12 @@
"body"
]
},
- "example": {
- "body": "Do you like apples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like apples?"
+ }
+ }
}
}
}
@@ -81806,8 +81882,12 @@
"body"
]
},
- "example": {
- "body": "Do you like pineapples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like pineapples?"
+ }
+ }
}
}
}
@@ -84367,8 +84447,12 @@
"group_id"
]
},
- "example": {
- "group_id": 123
+ "examples": {
+ "default": {
+ "value": {
+ "group_id": 123
+ }
+ }
}
}
}
@@ -138863,9 +138947,13 @@
"url_template"
]
},
- "example": {
- "key_prefix": "TICKET-",
- "url_template": "https://example.com/TICKET?query="
+ "examples": {
+ "default": {
+ "value": {
+ "key_prefix": "TICKET-",
+ "url_template": "https://example.com/TICKET?query="
+ }
+ }
}
}
}
@@ -147264,26 +147352,30 @@
}
}
},
- "example": {
- "dismissal_restrictions": {
- "users": [
- "octocat"
- ],
- "teams": [
- "justice-league"
- ]
- },
- "bypass_pull_request_allowances": {
- "users": [
- "octocat"
- ],
- "teams": [
- "justice-league"
- ]
- },
- "dismiss_stale_reviews": true,
- "require_code_owner_reviews": true,
- "required_approving_review_count": 2
+ "examples": {
+ "default": {
+ "value": {
+ "dismissal_restrictions": {
+ "users": [
+ "octocat"
+ ],
+ "teams": [
+ "justice-league"
+ ]
+ },
+ "bypass_pull_request_allowances": {
+ "users": [
+ "octocat"
+ ],
+ "teams": [
+ "justice-league"
+ ]
+ },
+ "dismiss_stale_reviews": true,
+ "require_code_owner_reviews": true,
+ "required_approving_review_count": 2
+ }
+ }
}
}
}
@@ -148861,11 +148953,15 @@
}
}
},
- "example": {
- "strict": true,
- "contexts": [
- "continuous-integration/travis-ci"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "strict": true,
+ "contexts": [
+ "continuous-integration/travis-ci"
+ ]
+ }
+ }
}
}
}
@@ -166109,13 +166205,17 @@
}
}
},
- "example": {
- "auto_trigger_checks": [
- {
- "app_id": 4,
- "setting": false
+ "examples": {
+ "default": {
+ "value": {
+ "auto_trigger_checks": [
+ {
+ "app_id": 4,
+ "setting": false
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -174355,9 +174455,13 @@
"state"
]
},
- "example": {
- "state": "dismissed",
- "dismissed_reason": "false positive"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "dismissed",
+ "dismissed_reason": "false positive"
+ }
+ }
}
}
}
@@ -181068,8 +181172,12 @@
"body"
]
},
- "example": {
- "body": "Nice change"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Nice change"
+ }
+ }
}
}
}
@@ -181982,7 +182090,7 @@
"content"
]
},
- "example": {
+ "examples": {
"default": {
"value": {
"content": "heart"
@@ -184389,11 +184497,15 @@
"body"
]
},
- "example": {
- "body": "Great stuff",
- "path": "file1.txt",
- "position": 4,
- "line": 1
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Great stuff",
+ "path": "file1.txt",
+ "position": 4,
+ "line": 1
+ }
+ }
}
}
}
@@ -202688,13 +202800,17 @@
"sha"
]
},
- "example": {
- "message": "my commit message",
- "committer": {
- "name": "Monalisa Octocat",
- "email": "octocat@github.com"
- },
- "sha": "329688480d39049927147c162b9d2deaf885005f"
+ "examples": {
+ "default": {
+ "value": {
+ "message": "my commit message",
+ "committer": {
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com"
+ },
+ "sha": "329688480d39049927147c162b9d2deaf885005f"
+ }
+ }
}
}
}
@@ -206782,11 +206898,15 @@
"state"
]
},
- "example": {
- "environment": "production",
- "state": "success",
- "log_url": "https://example.com/deployment/42/output",
- "description": "Deployment finished successfully."
+ "examples": {
+ "default": {
+ "value": {
+ "environment": "production",
+ "state": "success",
+ "log_url": "https://example.com/deployment/42/output",
+ "description": "Deployment finished successfully."
+ }
+ }
}
}
}
@@ -222995,9 +223115,13 @@
"content"
]
},
- "example": {
- "content": "Content of the blob",
- "encoding": "utf-8"
+ "examples": {
+ "default": {
+ "value": {
+ "content": "Content of the blob",
+ "encoding": "utf-8"
+ }
+ }
}
}
}
@@ -224582,9 +224706,13 @@
"sha"
]
},
- "example": {
- "ref": "refs/heads/featureA",
- "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd"
+ "examples": {
+ "default": {
+ "value": {
+ "ref": "refs/heads/featureA",
+ "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd"
+ }
+ }
}
}
}
@@ -224813,9 +224941,13 @@
"sha"
]
},
- "example": {
- "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
- "force": true
+ "examples": {
+ "default": {
+ "value": {
+ "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
+ "force": true
+ }
+ }
}
}
}
@@ -225190,15 +225322,19 @@
"type"
]
},
- "example": {
- "tag": "v0.0.1",
- "message": "initial version",
- "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
- "type": "commit",
- "tagger": {
- "name": "Monalisa Octocat",
- "email": "octocat@github.com",
- "date": "2011-06-17T14:53:35-07:00"
+ "examples": {
+ "default": {
+ "value": {
+ "tag": "v0.0.1",
+ "message": "initial version",
+ "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
+ "type": "commit",
+ "tagger": {
+ "name": "Monalisa Octocat",
+ "email": "octocat@github.com",
+ "date": "2011-06-17T14:53:35-07:00"
+ }
+ }
}
}
}
@@ -225767,16 +225903,20 @@
"tree"
]
},
- "example": {
- "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
- "tree": [
- {
- "path": "file.rb",
- "mode": "100644",
- "type": "blob",
- "sha": "44b4fc6d56897b048c772eb4087f854f46256132"
+ "examples": {
+ "default": {
+ "value": {
+ "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
+ "tree": [
+ {
+ "path": "file.rb",
+ "mode": "100644",
+ "type": "blob",
+ "sha": "44b4fc6d56897b048c772eb4087f854f46256132"
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -226835,17 +226975,21 @@
},
"additionalProperties": false
},
- "example": {
- "name": "web",
- "active": true,
- "events": [
- "push",
- "pull_request"
- ],
- "config": {
- "url": "https://example.com/webhook",
- "content_type": "json",
- "insecure_ssl": "0"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "web",
+ "active": true,
+ "events": [
+ "push",
+ "pull_request"
+ ],
+ "config": {
+ "url": "https://example.com/webhook",
+ "content_type": "json",
+ "insecure_ssl": "0"
+ }
+ }
}
}
}
@@ -227683,11 +227827,15 @@
}
}
},
- "example": {
- "active": true,
- "add_events": [
- "pull_request"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "active": true,
+ "add_events": [
+ "pull_request"
+ ]
+ }
+ }
}
}
}
@@ -239522,16 +239670,20 @@
"title"
]
},
- "example": {
- "title": "Found a bug",
- "body": "I'm having a problem with this.",
- "assignees": [
- "octocat"
- ],
- "milestone": 1,
- "labels": [
- "bug"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Found a bug",
+ "body": "I'm having a problem with this.",
+ "assignees": [
+ "octocat"
+ ],
+ "milestone": 1,
+ "labels": [
+ "bug"
+ ]
+ }
+ }
}
}
}
@@ -244573,8 +244725,12 @@
"body"
]
},
- "example": {
- "body": "Me too"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Me too"
+ }
+ }
}
}
}
@@ -263158,11 +263314,15 @@
}
}
},
- "example": {
- "assignees": [
- "hubot",
- "other_user"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "assignees": [
+ "hubot",
+ "other_user"
+ ]
+ }
+ }
}
}
}
@@ -266376,11 +266536,15 @@
}
}
},
- "example": {
- "assignees": [
- "hubot",
- "other_user"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "assignees": [
+ "hubot",
+ "other_user"
+ ]
+ }
+ }
}
}
}
@@ -270417,8 +270581,12 @@
"body"
]
},
- "example": {
- "body": "Me too"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Me too"
+ }
+ }
}
}
}
@@ -281722,11 +281890,15 @@
}
]
},
- "example": {
- "labels": [
- "bug",
- "enhancement"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "labels": [
+ "bug",
+ "enhancement"
+ ]
+ }
+ }
}
}
}
@@ -282045,11 +282217,15 @@
}
]
},
- "example": {
- "labels": [
- "bug",
- "enhancement"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "labels": [
+ "bug",
+ "enhancement"
+ ]
+ }
+ }
}
}
}
@@ -299838,10 +300014,14 @@
"key"
]
},
- "example": {
- "title": "octocat@octomac",
- "key": "ssh-rsa AAA...",
- "read_only": true
+ "examples": {
+ "default": {
+ "value": {
+ "title": "octocat@octomac",
+ "key": "ssh-rsa AAA...",
+ "read_only": true
+ }
+ }
}
}
}
@@ -300422,10 +300602,14 @@
"name"
]
},
- "example": {
- "name": "bug",
- "description": "Something isn't working",
- "color": "f29513"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "bug",
+ "description": "Something isn't working",
+ "color": "f29513"
+ }
+ }
}
}
}
@@ -300852,10 +301036,14 @@
}
}
},
- "example": {
- "new_name": "bug :bug:",
- "description": "Small bug fix required",
- "color": "b01f26"
+ "examples": {
+ "default": {
+ "value": {
+ "new_name": "bug :bug:",
+ "description": "Small bug fix required",
+ "color": "b01f26"
+ }
+ }
}
}
}
@@ -301442,8 +301630,12 @@
"branch"
]
},
- "example": {
- "branch": "main"
+ "examples": {
+ "default": {
+ "value": {
+ "branch": "main"
+ }
+ }
}
}
}
@@ -303027,11 +303219,15 @@
"title"
]
},
- "example": {
- "title": "v1.0",
- "state": "open",
- "description": "Tracking milestone for version 1.0",
- "due_on": "2012-10-09T23:39:01Z"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "v1.0",
+ "state": "open",
+ "description": "Tracking milestone for version 1.0",
+ "due_on": "2012-10-09T23:39:01Z"
+ }
+ }
}
}
}
@@ -304008,11 +304204,15 @@
}
}
},
- "example": {
- "title": "v1.0",
- "state": "open",
- "description": "Tracking milestone for version 1.0",
- "due_on": "2012-10-09T23:39:01Z"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "v1.0",
+ "state": "open",
+ "description": "Tracking milestone for version 1.0",
+ "due_on": "2012-10-09T23:39:01Z"
+ }
+ }
}
}
}
@@ -309794,9 +309994,13 @@
"name"
]
},
- "example": {
- "name": "Projects Documentation",
- "body": "Developer documentation project for the developer site."
+ "examples": {
+ "default": {
+ "value": {
+ "name": "Projects Documentation",
+ "body": "Developer documentation project for the developer site."
+ }
+ }
}
}
}
@@ -315972,11 +316176,15 @@
"base"
]
},
- "example": {
- "title": "Amazing new feature",
- "body": "Please pull these awesome changes in!",
- "head": "octocat:new-feature",
- "base": "master"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Amazing new feature",
+ "body": "Please pull these awesome changes in!",
+ "head": "octocat:new-feature",
+ "base": "master"
+ }
+ }
}
}
}
@@ -321208,8 +321416,12 @@
"body"
]
},
- "example": {
- "body": "I like this too!"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "I like this too!"
+ }
+ }
}
}
}
@@ -326905,11 +327117,15 @@
}
}
},
- "example": {
- "title": "new title",
- "body": "updated body",
- "state": "open",
- "base": "master"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "new title",
+ "body": "updated body",
+ "state": "open",
+ "base": "master"
+ }
+ }
}
}
}
@@ -332309,8 +332525,12 @@
"body"
]
},
- "example": {
- "body": "Great stuff!"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Great stuff!"
+ }
+ }
}
}
}
@@ -334994,15 +335214,19 @@
}
]
},
- "example": {
- "reviewers": [
- "octocat",
- "hubot",
- "other_user"
- ],
- "team_reviewers": [
- "justice-league"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "reviewers": [
+ "octocat",
+ "hubot",
+ "other_user"
+ ],
+ "team_reviewers": [
+ "justice-league"
+ ]
+ }
+ }
}
}
}
@@ -346082,17 +346306,21 @@
}
}
},
- "example": {
- "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
- "body": "This is close to perfect! Please address the suggested inline change.",
- "event": "REQUEST_CHANGES",
- "comments": [
- {
- "path": "file.md",
- "position": 6,
- "body": "Please add more information here, and fix this typo."
+ "examples": {
+ "default": {
+ "value": {
+ "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
+ "body": "This is close to perfect! Please address the suggested inline change.",
+ "event": "REQUEST_CHANGES",
+ "comments": [
+ {
+ "path": "file.md",
+ "position": 6,
+ "body": "Please add more information here, and fix this typo."
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -351087,13 +351315,17 @@
"tag_name"
]
},
- "example": {
- "tag_name": "v1.0.0",
- "target_commitish": "master",
- "name": "v1.0.0",
- "body": "Description of the release",
- "draft": false,
- "prerelease": false
+ "examples": {
+ "default": {
+ "value": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "master",
+ "name": "v1.0.0",
+ "body": "Description of the release",
+ "draft": false,
+ "prerelease": false
+ }
+ }
}
}
}
@@ -352306,9 +352538,13 @@
}
}
},
- "example": {
- "name": "foo-1.0.0-osx.zip",
- "label": "Mac binary"
+ "examples": {
+ "default": {
+ "value": {
+ "name": "foo-1.0.0-osx.zip",
+ "label": "Mac binary"
+ }
+ }
}
}
}
@@ -354922,13 +355158,17 @@
}
}
},
- "example": {
- "tag_name": "v1.0.0",
- "target_commitish": "master",
- "name": "v1.0.0",
- "body": "Description of the release",
- "draft": false,
- "prerelease": false
+ "examples": {
+ "default": {
+ "value": {
+ "tag_name": "v1.0.0",
+ "target_commitish": "master",
+ "name": "v1.0.0",
+ "body": "Description of the release",
+ "draft": false,
+ "prerelease": false
+ }
+ }
}
}
}
@@ -358364,9 +358604,13 @@
"state"
]
},
- "example": {
- "state": "resolved",
- "resolution": "false_positive"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "resolved",
+ "resolution": "false_positive"
+ }
+ }
}
}
}
@@ -360128,11 +360372,15 @@
"state"
]
},
- "example": {
- "state": "success",
- "target_url": "https://example.com/build/status",
- "description": "The build succeeded!",
- "context": "continuous-integration/jenkins"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "success",
+ "target_url": "https://example.com/build/status",
+ "description": "The build succeeded!",
+ "context": "continuous-integration/jenkins"
+ }
+ }
}
}
}
@@ -361660,13 +361908,17 @@
"names"
]
},
- "example": {
- "names": [
- "octocat",
- "atom",
- "electron",
- "api"
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "names": [
+ "octocat",
+ "atom",
+ "electron",
+ "api"
+ ]
+ }
+ }
}
}
}
@@ -361825,12 +362077,16 @@
"new_owner"
]
},
- "example": {
- "new_owner": "github",
- "team_ids": [
- 12,
- 345
- ]
+ "examples": {
+ "default": {
+ "value": {
+ "new_owner": "github",
+ "team_ids": [
+ 12,
+ 345
+ ]
+ }
+ }
}
}
}
@@ -364308,12 +364564,16 @@
"name"
]
},
- "example": {
- "owner": "octocat",
- "name": "Hello-World",
- "description": "This is your first repository",
- "include_all_branches": false,
- "private": false
+ "examples": {
+ "default": {
+ "value": {
+ "owner": "octocat",
+ "name": "Hello-World",
+ "description": "This is your first repository",
+ "include_all_branches": false,
+ "private": false
+ }
+ }
}
}
}
@@ -366117,19 +366377,23 @@
"displayName"
]
},
- "example": {
- "schemas": [
- "urn:ietf:params:scim:schemas:core:2.0:Group"
- ],
- "displayName": "octo-org",
- "members": [
- {
- "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc"
- },
- {
- "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5"
+ "examples": {
+ "default": {
+ "value": {
+ "schemas": [
+ "urn:ietf:params:scim:schemas:core:2.0:Group"
+ ],
+ "displayName": "octo-org",
+ "members": [
+ {
+ "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc"
+ },
+ {
+ "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5"
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -366460,19 +366724,23 @@
"displayName"
]
},
- "example": {
- "schemas": [
- "urn:ietf:params:scim:schemas:core:2.0:Group"
- ],
- "displayName": "octo-org",
- "members": [
- {
- "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc"
- },
- {
- "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5"
+ "examples": {
+ "default": {
+ "value": {
+ "schemas": [
+ "urn:ietf:params:scim:schemas:core:2.0:Group"
+ ],
+ "displayName": "octo-org",
+ "members": [
+ {
+ "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc"
+ },
+ {
+ "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5"
+ }
+ ]
}
- ]
+ }
}
}
}
@@ -366665,21 +366933,25 @@
"Operations"
]
},
- "example": {
- "schemas": [
- "urn:ietf:params:scim:api:messages:2.0:PatchOp"
- ],
- "Operations": [
- {
- "op": "remove",
- "path": "members",
- "value": [
+ "examples": {
+ "default": {
+ "value": {
+ "schemas": [
+ "urn:ietf:params:scim:api:messages:2.0:PatchOp"
+ ],
+ "Operations": [
{
- "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5"
+ "op": "remove",
+ "path": "members",
+ "value": [
+ {
+ "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5"
+ }
+ ]
}
]
}
- ]
+ }
}
}
}
@@ -380381,9 +380653,13 @@
"body"
]
},
- "example": {
- "title": "Our first team post",
- "body": "Hi! This is an area for us to collaborate as a team."
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Our first team post",
+ "body": "Hi! This is an area for us to collaborate as a team."
+ }
+ }
}
}
}
@@ -381316,8 +381592,12 @@
}
}
},
- "example": {
- "title": "Welcome to our first team post"
+ "examples": {
+ "default": {
+ "value": {
+ "title": "Welcome to our first team post"
+ }
+ }
}
}
}
@@ -382293,8 +382573,12 @@
"body"
]
},
- "example": {
- "body": "Do you like apples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like apples?"
+ }
+ }
}
}
}
@@ -383154,8 +383438,12 @@
"body"
]
},
- "example": {
- "body": "Do you like pineapples?"
+ "examples": {
+ "default": {
+ "value": {
+ "body": "Do you like pineapples?"
+ }
+ }
}
}
}
@@ -402904,8 +403192,12 @@
"state"
]
},
- "example": {
- "state": "active"
+ "examples": {
+ "default": {
+ "value": {
+ "state": "active"
+ }
+ }
}
}
}
diff --git a/lib/search/indexes/github-docs-3.1-cn-records.json.br b/lib/search/indexes/github-docs-3.1-cn-records.json.br
index 23ef6f196eeb..b772fb3240d5 100644
--- a/lib/search/indexes/github-docs-3.1-cn-records.json.br
+++ b/lib/search/indexes/github-docs-3.1-cn-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:c17b2cb2a315a53ad2905d85bb542917cc419ced2c2e80fde6db4d55982de34b
-size 659431
+oid sha256:9e2f1de664536f74b41c6e47f1d8bf32515e95b8df1160724bf638b9cfbe3b33
+size 659374
diff --git a/lib/search/indexes/github-docs-3.1-cn.json.br b/lib/search/indexes/github-docs-3.1-cn.json.br
index 1599b4e872a6..05acab2dbdec 100644
--- a/lib/search/indexes/github-docs-3.1-cn.json.br
+++ b/lib/search/indexes/github-docs-3.1-cn.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:707ed9e3ba7366246206ea4dd2fdf21c4a6b5257763e030d675b5ad7910f8fe0
-size 1338199
+oid sha256:8d54e45ee308cb1c67db6caaf693436c5fd601e7bb1c680f55ed99da9a8029d5
+size 1336312
diff --git a/lib/search/indexes/github-docs-3.1-en-records.json.br b/lib/search/indexes/github-docs-3.1-en-records.json.br
index a533678a2d1d..ff8075cc7032 100644
--- a/lib/search/indexes/github-docs-3.1-en-records.json.br
+++ b/lib/search/indexes/github-docs-3.1-en-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:9a994baef01d858d0420f73bb9df22065e7f8d4864169b9fadfe50bd020db207
-size 881340
+oid sha256:d3b02f41b44b221eebe8ce46b98f75c79dbfefd5c168bc485332e36ef435d52b
+size 878662
diff --git a/lib/search/indexes/github-docs-3.1-en.json.br b/lib/search/indexes/github-docs-3.1-en.json.br
index 565bdf329820..ef6c4e979c04 100644
--- a/lib/search/indexes/github-docs-3.1-en.json.br
+++ b/lib/search/indexes/github-docs-3.1-en.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:f481ad83bed3f4eeed25d83abff09db93c308431b80fa688c9ac9650a726f867
-size 3386527
+oid sha256:d2aa01b72dbb1813380b7dadf61c574d2c0fcea251a17d2d0ecb3a4947baa791
+size 3388831
diff --git a/lib/search/indexes/github-docs-3.1-es-records.json.br b/lib/search/indexes/github-docs-3.1-es-records.json.br
index 4455314899ac..178391f25918 100644
--- a/lib/search/indexes/github-docs-3.1-es-records.json.br
+++ b/lib/search/indexes/github-docs-3.1-es-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:054bd5f544e188addb0c12ce5b0e5c3044b5d7dfc423d9d02a3b3052a880bdf6
-size 608130
+oid sha256:2882af23437caaed447185c13e9c751d699300e8260b029464447e8b20decf18
+size 608327
diff --git a/lib/search/indexes/github-docs-3.1-es.json.br b/lib/search/indexes/github-docs-3.1-es.json.br
index 6728b5276563..9d40f27e60f7 100644
--- a/lib/search/indexes/github-docs-3.1-es.json.br
+++ b/lib/search/indexes/github-docs-3.1-es.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:39058c9bda8943c5646ea1c2b580963fc64e9c666b9e7e481ee23fbadb29c7a9
-size 2563750
+oid sha256:fe26580778bce7c09563cd1f3e67340f327e967938e0060dbceb09550b90bd40
+size 2561402
diff --git a/lib/search/indexes/github-docs-3.1-ja-records.json.br b/lib/search/indexes/github-docs-3.1-ja-records.json.br
index cf5f82081966..fda0b820ff54 100644
--- a/lib/search/indexes/github-docs-3.1-ja-records.json.br
+++ b/lib/search/indexes/github-docs-3.1-ja-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:fa6238f86180227d8eda6e839c7d860ac6a21c58e24cfa04d5ff6c98609d4625
-size 673364
+oid sha256:31817c6021646761939219d173aeec4b84bb1eaf355fd4727bc3b9c5ed535514
+size 673434
diff --git a/lib/search/indexes/github-docs-3.1-ja.json.br b/lib/search/indexes/github-docs-3.1-ja.json.br
index 3dc9e50c760a..80c334655637 100644
--- a/lib/search/indexes/github-docs-3.1-ja.json.br
+++ b/lib/search/indexes/github-docs-3.1-ja.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:ff679ea6707a41dc43d55ae9bc0cb58d0ce0f72f8dafc63158af4171d761f79d
-size 3574617
+oid sha256:c70c692bc4cc963db1ff5880991679eca79bfb612f089ce8aafed52b75809667
+size 3576270
diff --git a/lib/search/indexes/github-docs-3.1-pt-records.json.br b/lib/search/indexes/github-docs-3.1-pt-records.json.br
index cee7a3cd282c..984ca9fe7a14 100644
--- a/lib/search/indexes/github-docs-3.1-pt-records.json.br
+++ b/lib/search/indexes/github-docs-3.1-pt-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:0999eeea791e7768e72eba6521c386b3c2f46ec4ccaa2a10ba08e3e16d3c96f9
-size 599380
+oid sha256:33a6f6fefdcb946e6d140d3fe4dc0fb460996617cb1f1bc6e9d6d6ff6a3c7992
+size 599500
diff --git a/lib/search/indexes/github-docs-3.1-pt.json.br b/lib/search/indexes/github-docs-3.1-pt.json.br
index fb5ae8a89cca..4517eb1e4c81 100644
--- a/lib/search/indexes/github-docs-3.1-pt.json.br
+++ b/lib/search/indexes/github-docs-3.1-pt.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:12df5f5fafca3a4c8f82a5b5c913256b4df850477cdebb7edb96464dd9abe5de
-size 2444104
+oid sha256:cb76d18bb3f32cfd2d1d698ce5715ef74d872b495ee3ded04a8f11220500b377
+size 2445898
diff --git a/lib/search/indexes/github-docs-3.2-cn-records.json.br b/lib/search/indexes/github-docs-3.2-cn-records.json.br
index ab6455074e5d..7e2d544c707e 100644
--- a/lib/search/indexes/github-docs-3.2-cn-records.json.br
+++ b/lib/search/indexes/github-docs-3.2-cn-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:a112f8861a25b4cc179d5c5f56bf7fdc1b17ff7988e96210c2f0fef2ba1606b0
-size 676918
+oid sha256:c921e1db351ba4fd2998e43af98a572f641f00f417d411ca53060991d87e416c
+size 677255
diff --git a/lib/search/indexes/github-docs-3.2-cn.json.br b/lib/search/indexes/github-docs-3.2-cn.json.br
index cb0a904f5782..af208d2ffbde 100644
--- a/lib/search/indexes/github-docs-3.2-cn.json.br
+++ b/lib/search/indexes/github-docs-3.2-cn.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:7df571156a2376b1bb081afde2a6a31f93e889ed52347402e4c9b300a3e81345
-size 1367466
+oid sha256:ed5e2088de7cc8f16f61baade005e23f8d537d70b0db88915c3bdd42772c942e
+size 1367724
diff --git a/lib/search/indexes/github-docs-3.2-en-records.json.br b/lib/search/indexes/github-docs-3.2-en-records.json.br
index 0d4cc70edd0a..6c7c91681781 100644
--- a/lib/search/indexes/github-docs-3.2-en-records.json.br
+++ b/lib/search/indexes/github-docs-3.2-en-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:48f0279190127828bfc5bd81737e4c056ca23f7329124120548e9a1bab8551a1
-size 909420
+oid sha256:6dc6d17b0ecf58b049af06c6a9200b8aeb278418e2e0ef75a0880ea81c2be565
+size 910665
diff --git a/lib/search/indexes/github-docs-3.2-en.json.br b/lib/search/indexes/github-docs-3.2-en.json.br
index 35439b6b2573..8a23b72d520a 100644
--- a/lib/search/indexes/github-docs-3.2-en.json.br
+++ b/lib/search/indexes/github-docs-3.2-en.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:59b07bd701a95328c36dc7747619db389349f5ba6eba0e0a1d384bc3b6d5540e
-size 3503905
+oid sha256:41f500cc304bf31266eadf3d9a159d1bb91362d798e9a6e4b9ad6cc910918e14
+size 3504576
diff --git a/lib/search/indexes/github-docs-3.2-es-records.json.br b/lib/search/indexes/github-docs-3.2-es-records.json.br
index 653e1bd78432..c05bef770801 100644
--- a/lib/search/indexes/github-docs-3.2-es-records.json.br
+++ b/lib/search/indexes/github-docs-3.2-es-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:7c9f1ceea916ac7a966f0f38d80c3968ef920e338452ecc29be644b2ef93e5d0
-size 625696
+oid sha256:fc6497fc52f80e0496d1f5e063aa6eb9b9be7134325a5e1a2ef15f01c0aed516
+size 624815
diff --git a/lib/search/indexes/github-docs-3.2-es.json.br b/lib/search/indexes/github-docs-3.2-es.json.br
index 8776bbdccac8..5670e3e165f7 100644
--- a/lib/search/indexes/github-docs-3.2-es.json.br
+++ b/lib/search/indexes/github-docs-3.2-es.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:adaacf4d66272f9173d4ec48ddef601e8dfb54510824c6252149d59608436078
-size 2636705
+oid sha256:9679186f1e6215621ef6df7354a8ce0affeceb4b361490b8749de879b8b811a0
+size 2631438
diff --git a/lib/search/indexes/github-docs-3.2-ja-records.json.br b/lib/search/indexes/github-docs-3.2-ja-records.json.br
index 1bcbbf4b673a..702af3ee35a6 100644
--- a/lib/search/indexes/github-docs-3.2-ja-records.json.br
+++ b/lib/search/indexes/github-docs-3.2-ja-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:13cc9cfed7d7095e83787033a4eba480ad93655cc34f94c10d33db150a440922
-size 690611
+oid sha256:4b81b8c7b5b3dbc74235f83062069e2a729bc38c7a24f6d6249ecf1000fd5303
+size 689953
diff --git a/lib/search/indexes/github-docs-3.2-ja.json.br b/lib/search/indexes/github-docs-3.2-ja.json.br
index a1d6d711082a..5fe8ca323a40 100644
--- a/lib/search/indexes/github-docs-3.2-ja.json.br
+++ b/lib/search/indexes/github-docs-3.2-ja.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:4c8ee95dccd980a8d1d4d66b85d9140af839d157cdaf7c7735fc508176db0ea5
-size 3668783
+oid sha256:5bad4bd8d74f11e044145961a6262c3207ab00ace10d211e1db33eda4795a5c1
+size 3668198
diff --git a/lib/search/indexes/github-docs-3.2-pt-records.json.br b/lib/search/indexes/github-docs-3.2-pt-records.json.br
index 5793eab99d16..be18417b941b 100644
--- a/lib/search/indexes/github-docs-3.2-pt-records.json.br
+++ b/lib/search/indexes/github-docs-3.2-pt-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:b0caaa17cd0d41f83aede94096167e69ec85df1b55abf1003b2a84382aa3d680
-size 614891
+oid sha256:293c4cf265021ef8f2f876ee530c9c49e7f9e7841074bf165dbf9ed09aa26360
+size 614570
diff --git a/lib/search/indexes/github-docs-3.2-pt.json.br b/lib/search/indexes/github-docs-3.2-pt.json.br
index d702f7754a80..6a0ebbaa1b19 100644
--- a/lib/search/indexes/github-docs-3.2-pt.json.br
+++ b/lib/search/indexes/github-docs-3.2-pt.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:d9c96a8e445a03a0d094cf9494c4e4c57798b65e3c50b844d8b25cd2897a8327
-size 2504686
+oid sha256:241fe223e86b20a203572b57dc4236211af76539e5ceb5f6461c968ea32d9b1d
+size 2504387
diff --git a/lib/search/indexes/github-docs-3.3-cn-records.json.br b/lib/search/indexes/github-docs-3.3-cn-records.json.br
index 274540cfcc32..97538cff1b3a 100644
--- a/lib/search/indexes/github-docs-3.3-cn-records.json.br
+++ b/lib/search/indexes/github-docs-3.3-cn-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:35a3a684a43a1498b5bbb655db59d44b9e791793ece13070dc928187c5aad574
-size 700426
+oid sha256:58de20dbc94f0bcfc2a247f9f8b39e05ed8e3d5085ebbb43877307724be4562a
+size 699587
diff --git a/lib/search/indexes/github-docs-3.3-cn.json.br b/lib/search/indexes/github-docs-3.3-cn.json.br
index 9fe80460d7b0..39a69e147db0 100644
--- a/lib/search/indexes/github-docs-3.3-cn.json.br
+++ b/lib/search/indexes/github-docs-3.3-cn.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:a203f2eb689078a96ed1f098c53e422c42448d906a0139fae8ba64163e29276d
-size 1421349
+oid sha256:c0b6bcedbc97fcd2dd656a8ba38c1234c0b4bd942e555f74d4e0b8a9ba70ef62
+size 1421532
diff --git a/lib/search/indexes/github-docs-3.3-en-records.json.br b/lib/search/indexes/github-docs-3.3-en-records.json.br
index ca9c6b7dab51..6795036bc22e 100644
--- a/lib/search/indexes/github-docs-3.3-en-records.json.br
+++ b/lib/search/indexes/github-docs-3.3-en-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:d60985759ffde52a547faecf9a52952b534e36f9041a3d2cfe359c185728d6d8
-size 946144
+oid sha256:ab394732a3a9aa1f6801e754facc6e27b38f7c27a785d19f73868a2dc541665e
+size 944193
diff --git a/lib/search/indexes/github-docs-3.3-en.json.br b/lib/search/indexes/github-docs-3.3-en.json.br
index 44b4abd80b00..fb2101d19dc1 100644
--- a/lib/search/indexes/github-docs-3.3-en.json.br
+++ b/lib/search/indexes/github-docs-3.3-en.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:7eadbec8aa5b4730b91fb5833c89f9f342b7389381db4ca02f3025ebc2d2669c
-size 3621453
+oid sha256:41bf4acdde14e9d0cd26fdf088f24f37ec3a8d0fa099a51be15a1fac81d806c0
+size 3619604
diff --git a/lib/search/indexes/github-docs-3.3-es-records.json.br b/lib/search/indexes/github-docs-3.3-es-records.json.br
index 1061982ac804..64780067a524 100644
--- a/lib/search/indexes/github-docs-3.3-es-records.json.br
+++ b/lib/search/indexes/github-docs-3.3-es-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:e7c58501c3f0d35d705da64eb09c2c02277038b6fe16684dd7c21208d2e2df76
-size 644186
+oid sha256:b6ab367aaa9bef06421c2c7d27ca8af9c0a47b899a98d23db8c82f8050b6b252
+size 644335
diff --git a/lib/search/indexes/github-docs-3.3-es.json.br b/lib/search/indexes/github-docs-3.3-es.json.br
index 45c8ab739391..ac65bf54b389 100644
--- a/lib/search/indexes/github-docs-3.3-es.json.br
+++ b/lib/search/indexes/github-docs-3.3-es.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:b98830a910bfcaa3499db2bfcb4d21b734334ca1e28d574c7a4d68fd048b0e5a
-size 2722693
+oid sha256:d5e921a9fb443a74e7e95790f7a03a15d84bafdf4819a90dab93c2c045a07582
+size 2717420
diff --git a/lib/search/indexes/github-docs-3.3-ja-records.json.br b/lib/search/indexes/github-docs-3.3-ja-records.json.br
index 1290b17d207b..37da72cdaaa5 100644
--- a/lib/search/indexes/github-docs-3.3-ja-records.json.br
+++ b/lib/search/indexes/github-docs-3.3-ja-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:1749577901fd6e5778f23cdfbaf05b0e451b9275ddb1d2dce4424fba10a6c7a6
-size 713159
+oid sha256:9e91e0627a705f9f725dc756f8e6d1db5a9f85830400467b86cdaf016280d58f
+size 713037
diff --git a/lib/search/indexes/github-docs-3.3-ja.json.br b/lib/search/indexes/github-docs-3.3-ja.json.br
index 7465d226504d..4320e6fb0ce8 100644
--- a/lib/search/indexes/github-docs-3.3-ja.json.br
+++ b/lib/search/indexes/github-docs-3.3-ja.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:2ae1d5544316b5ec501728ef88fa4544a7252e8be8e88b0e210ff00a9cde04a0
-size 3791595
+oid sha256:e3a88877fa661d310a05f7def95c8418fde3aa3435c62a1ab67288edec0f4141
+size 3789826
diff --git a/lib/search/indexes/github-docs-3.3-pt-records.json.br b/lib/search/indexes/github-docs-3.3-pt-records.json.br
index bbf8cbe2ad00..fe91d5dfcf70 100644
--- a/lib/search/indexes/github-docs-3.3-pt-records.json.br
+++ b/lib/search/indexes/github-docs-3.3-pt-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:f35d43d18444cf7dd0645564b267fb16ba6fa9d7153c9192d201d1b9bd1538e6
-size 633723
+oid sha256:6ac6d7d36ce89def83e769d6790bb8b36e30a8a4479d5c34ea6e59afc37debcf
+size 633769
diff --git a/lib/search/indexes/github-docs-3.3-pt.json.br b/lib/search/indexes/github-docs-3.3-pt.json.br
index 81eb0735a286..885571b1e91f 100644
--- a/lib/search/indexes/github-docs-3.3-pt.json.br
+++ b/lib/search/indexes/github-docs-3.3-pt.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:10fc3968569b106ce43c28addccb6ada6704b0cd03e50f5e7472209407d73997
-size 2583198
+oid sha256:ec5791e32cd33e740fc8f6dbec8fc634f82554d5b7b8a058fcf473f34f4a6004
+size 2584858
diff --git a/lib/search/indexes/github-docs-3.4-cn-records.json.br b/lib/search/indexes/github-docs-3.4-cn-records.json.br
index 87172f91f7bf..08ce956f08fd 100644
--- a/lib/search/indexes/github-docs-3.4-cn-records.json.br
+++ b/lib/search/indexes/github-docs-3.4-cn-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:460c54b3af478dee6194ddf53a272b89b8f1113aba6eeb3c7bcc226d32c4624f
-size 704921
+oid sha256:d86b22d314fd77beed4a27406857ef1cf8ffba3a48b31f3390afdbf3adb4c671
+size 703055
diff --git a/lib/search/indexes/github-docs-3.4-cn.json.br b/lib/search/indexes/github-docs-3.4-cn.json.br
index 39625d07b759..f639c4f5fedd 100644
--- a/lib/search/indexes/github-docs-3.4-cn.json.br
+++ b/lib/search/indexes/github-docs-3.4-cn.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:93f9b5793e210b700e6edfe9173f1ed17b23ef52591b02858fc9be3827112c53
-size 1432396
+oid sha256:f8b1465356d323956db6c91e69d3570d14662a52d34fe488b672c274b1290d72
+size 1432008
diff --git a/lib/search/indexes/github-docs-3.4-en-records.json.br b/lib/search/indexes/github-docs-3.4-en-records.json.br
index 99114efe4b09..4c2ff844887a 100644
--- a/lib/search/indexes/github-docs-3.4-en-records.json.br
+++ b/lib/search/indexes/github-docs-3.4-en-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:044d0d6e6f9d3d4bf8e2c3f7a3b8549119daefb622d01c99d0338a340f76a4b7
-size 955011
+oid sha256:c16910ca7364d84bf5a44fff5c338486350c08e3534fa5871fe51c51d81c594d
+size 955339
diff --git a/lib/search/indexes/github-docs-3.4-en.json.br b/lib/search/indexes/github-docs-3.4-en.json.br
index 71dcced6168e..e3dc7892b5f9 100644
--- a/lib/search/indexes/github-docs-3.4-en.json.br
+++ b/lib/search/indexes/github-docs-3.4-en.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:8255e10a2d2082c5a3d4894e9743f3dfe4d34b5d861f834cf4c01a3abfe4c0b4
-size 3659851
+oid sha256:ee47e93ae710ba4e20011133a3c650e3068b749409b2f54fd8f021706eb1ae87
+size 3657322
diff --git a/lib/search/indexes/github-docs-3.4-es-records.json.br b/lib/search/indexes/github-docs-3.4-es-records.json.br
index 0ee76230fb84..3d627e9cb9a3 100644
--- a/lib/search/indexes/github-docs-3.4-es-records.json.br
+++ b/lib/search/indexes/github-docs-3.4-es-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:4cb201733514b39028ca33903cb25014a72bd77bc5cad40d8fea5f531f39ee2e
-size 648270
+oid sha256:786247196c35526ecdf294d909eaeaaf90c4a241ec4eef5700a204b30f1aaeac
+size 648030
diff --git a/lib/search/indexes/github-docs-3.4-es.json.br b/lib/search/indexes/github-docs-3.4-es.json.br
index 5c856340d0e7..ea56d1917286 100644
--- a/lib/search/indexes/github-docs-3.4-es.json.br
+++ b/lib/search/indexes/github-docs-3.4-es.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:567aa950d9fee7a53bb84e8ea1bf303eef4d0291e7c2b540db77386dffa566c6
-size 2736082
+oid sha256:9c1906d13225f4dea597f085da2a7113636ac3ed893ade7ec8d0f619b8497595
+size 2731917
diff --git a/lib/search/indexes/github-docs-3.4-ja-records.json.br b/lib/search/indexes/github-docs-3.4-ja-records.json.br
index 0043d55db484..3ffdbbcaf5b4 100644
--- a/lib/search/indexes/github-docs-3.4-ja-records.json.br
+++ b/lib/search/indexes/github-docs-3.4-ja-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:a5b0c160038922aacfaa96ff6673105f0982a44469c14d913fa26e8371063839
-size 717390
+oid sha256:a210121de53422b360154fcdf31881e9dc3de84c9990ccc044510fb85cb39981
+size 715853
diff --git a/lib/search/indexes/github-docs-3.4-ja.json.br b/lib/search/indexes/github-docs-3.4-ja.json.br
index d823eaf599d9..25c52ab28666 100644
--- a/lib/search/indexes/github-docs-3.4-ja.json.br
+++ b/lib/search/indexes/github-docs-3.4-ja.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:ac8c5ad6c9be6499b1f88a0b128c131711e81ff1e9d02ebc8cb0961d3433e0d0
-size 3812069
+oid sha256:55b5cf39d2a0a9ee10f6eb579e238ce221db45ff934af2e73d9a95538992faca
+size 3809403
diff --git a/lib/search/indexes/github-docs-3.4-pt-records.json.br b/lib/search/indexes/github-docs-3.4-pt-records.json.br
index c03fd00042d1..787161f93e0c 100644
--- a/lib/search/indexes/github-docs-3.4-pt-records.json.br
+++ b/lib/search/indexes/github-docs-3.4-pt-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:50706466d074e18a1b13bf1d639740197478dfae03dce4352b07eb7f5a29b691
-size 638336
+oid sha256:7ba40c0eef36a632387b202c40cdbb4564b54250817451ff1188d1b0f6311549
+size 637111
diff --git a/lib/search/indexes/github-docs-3.4-pt.json.br b/lib/search/indexes/github-docs-3.4-pt.json.br
index 62d2a8de12bb..d3942f032935 100644
--- a/lib/search/indexes/github-docs-3.4-pt.json.br
+++ b/lib/search/indexes/github-docs-3.4-pt.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:6da4e91107daf8efd5c65a0586f3253ee6004bfe8e940808ff05de693b4d502f
-size 2600435
+oid sha256:7dce6305fc42744470801d94ade3095d41348bd0485a826cf9c64f3adec1a75e
+size 2599698
diff --git a/lib/search/indexes/github-docs-dotcom-cn-records.json.br b/lib/search/indexes/github-docs-dotcom-cn-records.json.br
index 2bc68c4199f3..0ba2c2f940a9 100644
--- a/lib/search/indexes/github-docs-dotcom-cn-records.json.br
+++ b/lib/search/indexes/github-docs-dotcom-cn-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:31dde612478888455acdfc300da7e8e5c01396e581f479d0dad9c49c2117c62c
-size 908904
+oid sha256:738ac5146752001023161398ccfa0b2ea8727de0863d441643a20bf881516ecc
+size 909200
diff --git a/lib/search/indexes/github-docs-dotcom-cn.json.br b/lib/search/indexes/github-docs-dotcom-cn.json.br
index 2ecf790c8518..37992b0694b7 100644
--- a/lib/search/indexes/github-docs-dotcom-cn.json.br
+++ b/lib/search/indexes/github-docs-dotcom-cn.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:c61508b14624210e027c7b26d678a2b1067f527dff5df1b196e57d0023d933d2
-size 1563392
+oid sha256:08909e3fdda503db0898e3c47b8fad838afd35665b146fd48069eabaff8c7155
+size 1563441
diff --git a/lib/search/indexes/github-docs-dotcom-en-records.json.br b/lib/search/indexes/github-docs-dotcom-en-records.json.br
index 3674bf332193..26ab0e7aed19 100644
--- a/lib/search/indexes/github-docs-dotcom-en-records.json.br
+++ b/lib/search/indexes/github-docs-dotcom-en-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:56774aef4d67973ce46656b1afbe2e7e4faeb3833119b1d6fb255a31ff6d8782
-size 1225008
+oid sha256:2ffa91b4a427d9eba060c2cf9c50790e2bf67904767d964fc9971d442d9f2e59
+size 1226244
diff --git a/lib/search/indexes/github-docs-dotcom-en.json.br b/lib/search/indexes/github-docs-dotcom-en.json.br
index 967d65986109..60086d84decf 100644
--- a/lib/search/indexes/github-docs-dotcom-en.json.br
+++ b/lib/search/indexes/github-docs-dotcom-en.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:786a003e4ba17175cb4d8146c430601421d6e362e31e5da5107c3f104ff14b9d
-size 4417458
+oid sha256:99b954a4b48237a8e77cbc304e190ca4fd1637c26c7cd95f72808f2a2c27044f
+size 4419910
diff --git a/lib/search/indexes/github-docs-dotcom-es-records.json.br b/lib/search/indexes/github-docs-dotcom-es-records.json.br
index 81af1ec3ba61..f4e5ed942f9f 100644
--- a/lib/search/indexes/github-docs-dotcom-es-records.json.br
+++ b/lib/search/indexes/github-docs-dotcom-es-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:c3c015a636fa4422bd73441874e77888fadf5517b477cecb493aae8d0183a3b0
-size 818580
+oid sha256:8ab92bd8fb57efdb89431a5c3a1965d179b626947fd81b4ad46f2641a1a6cf13
+size 819241
diff --git a/lib/search/indexes/github-docs-dotcom-es.json.br b/lib/search/indexes/github-docs-dotcom-es.json.br
index 5fa22b4f9c0a..5b531ec8c5b3 100644
--- a/lib/search/indexes/github-docs-dotcom-es.json.br
+++ b/lib/search/indexes/github-docs-dotcom-es.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:3488fa2f9e76511b6d862cf83f714281f23dd6cc4c03bca84f489b2b7dce5bb0
-size 3278426
+oid sha256:0b39e57c4c0ea6c07dadc0bc6082059d25a1d47efb091bda53bb83ea89a5fee2
+size 3272438
diff --git a/lib/search/indexes/github-docs-dotcom-ja-records.json.br b/lib/search/indexes/github-docs-dotcom-ja-records.json.br
index caacfe2bc6b8..b6795cc3030e 100644
--- a/lib/search/indexes/github-docs-dotcom-ja-records.json.br
+++ b/lib/search/indexes/github-docs-dotcom-ja-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:ee736fd1282ab6690eac731c7eb29854bb708cfb24f139911bb1e411ecf28d12
-size 918868
+oid sha256:acef244817fcf5bd93f168f2037f0904d22e4d4027165b27febb6326528053a9
+size 920840
diff --git a/lib/search/indexes/github-docs-dotcom-ja.json.br b/lib/search/indexes/github-docs-dotcom-ja.json.br
index 8fd34c233470..4d84f6a3ec63 100644
--- a/lib/search/indexes/github-docs-dotcom-ja.json.br
+++ b/lib/search/indexes/github-docs-dotcom-ja.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:d9ad6088c1c51bca708751f6e33b2f1c359b54a764f3ad637eda20fa7b55dff4
-size 4664305
+oid sha256:725c12a3dab9b52c05d7f2f82a18488cc790ece25dc1f4ea70c03ae09fde9941
+size 4667762
diff --git a/lib/search/indexes/github-docs-dotcom-pt-records.json.br b/lib/search/indexes/github-docs-dotcom-pt-records.json.br
index 16784008f97e..97b3cb08c42b 100644
--- a/lib/search/indexes/github-docs-dotcom-pt-records.json.br
+++ b/lib/search/indexes/github-docs-dotcom-pt-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:c35937379e372d2ab2afef62a071dba0b964059582fac4d7de6c38f2a754314b
-size 806467
+oid sha256:eb2aea7336d3bef8257afd1785fb6253ceec206958b89e68ca8bd2ccef5e4cfb
+size 808331
diff --git a/lib/search/indexes/github-docs-dotcom-pt.json.br b/lib/search/indexes/github-docs-dotcom-pt.json.br
index 491f62176c68..4a2e9e4ffc45 100644
--- a/lib/search/indexes/github-docs-dotcom-pt.json.br
+++ b/lib/search/indexes/github-docs-dotcom-pt.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:a08618bbb4f89239503b465524eee2d8fe1976195e5afaa3caeba883049813da
-size 3122129
+oid sha256:f91915c17a4b69b4a68fbc2ec2aea67d4dedc8817db66514adf7f478a716ae6e
+size 3123550
diff --git a/lib/search/indexes/github-docs-ghae-cn-records.json.br b/lib/search/indexes/github-docs-ghae-cn-records.json.br
index 7088c1154166..40a525e31951 100644
--- a/lib/search/indexes/github-docs-ghae-cn-records.json.br
+++ b/lib/search/indexes/github-docs-ghae-cn-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:a7756f8567af72347685cf07c829c2e2554ffa30e9e3aa10a60cb15693274f99
-size 538038
+oid sha256:82274469549f2edd17b6236d1c302311d76b599af7bc5ddf8985c661b76f11d2
+size 537744
diff --git a/lib/search/indexes/github-docs-ghae-cn.json.br b/lib/search/indexes/github-docs-ghae-cn.json.br
index cc53092b2ec5..3e52ea719fb5 100644
--- a/lib/search/indexes/github-docs-ghae-cn.json.br
+++ b/lib/search/indexes/github-docs-ghae-cn.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:3645c19a4d034443765dd1f53431bfc7a7f595388e169142c1c434eb544dc71a
-size 1011863
+oid sha256:ef62a652ea8c962f4dc6ed56ab97bfec66c3365c4249804483251fca3300cde1
+size 1011199
diff --git a/lib/search/indexes/github-docs-ghae-en-records.json.br b/lib/search/indexes/github-docs-ghae-en-records.json.br
index c03fe78dd5de..f0c6832b4cac 100644
--- a/lib/search/indexes/github-docs-ghae-en-records.json.br
+++ b/lib/search/indexes/github-docs-ghae-en-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:f72386f7c16152d2b6b02af7153e5365aa42292a65e841266676bef1e5f4740e
-size 738489
+oid sha256:e80a9542caaac367f6a8614e9c8fc8b46adbe1cfba9f92d8c1702e32c49ae8d2
+size 739174
diff --git a/lib/search/indexes/github-docs-ghae-en.json.br b/lib/search/indexes/github-docs-ghae-en.json.br
index 1b1aa8d9926c..74d788c04bbc 100644
--- a/lib/search/indexes/github-docs-ghae-en.json.br
+++ b/lib/search/indexes/github-docs-ghae-en.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:f41897de14553f95d3b341d5e09e6574a13206a0bf0d8dc4a984375e7646483e
-size 2791686
+oid sha256:4c383a82c8207290e191779eb8e8b624af4bfbff99925fcfb2288a1e099e8523
+size 2790099
diff --git a/lib/search/indexes/github-docs-ghae-es-records.json.br b/lib/search/indexes/github-docs-ghae-es-records.json.br
index a2cb15979a7f..8be04b2c0083 100644
--- a/lib/search/indexes/github-docs-ghae-es-records.json.br
+++ b/lib/search/indexes/github-docs-ghae-es-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:64878cbc68e9d2ac3b34c500848d16926708033adae5db3e709e5c3971e90403
-size 496774
+oid sha256:4ae3df4a015d0725489df7e1d3c79db1de037e776b68815eb1d60018643fa1d9
+size 496682
diff --git a/lib/search/indexes/github-docs-ghae-es.json.br b/lib/search/indexes/github-docs-ghae-es.json.br
index a7a17c95c1a1..abb63eebf3c7 100644
--- a/lib/search/indexes/github-docs-ghae-es.json.br
+++ b/lib/search/indexes/github-docs-ghae-es.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:6804552e7ca0e54f1347f3f69c6c86dbf03c298c56a5e29d2a306af7f988d6d1
-size 2016210
+oid sha256:e29e0771921d39bf92c7e10a4452e8208850d6970d902d7d20d5fda35744adc6
+size 2011144
diff --git a/lib/search/indexes/github-docs-ghae-ja-records.json.br b/lib/search/indexes/github-docs-ghae-ja-records.json.br
index fc5225bbd6ad..deb66656617e 100644
--- a/lib/search/indexes/github-docs-ghae-ja-records.json.br
+++ b/lib/search/indexes/github-docs-ghae-ja-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:a39fe32cb10b770a743dc4c4821977f7c1c30ac04ba4d0ef7531ab0251cdf554
-size 547747
+oid sha256:939b083a3d4c689791461a691807caee1a553bdba1d164329adb95ee7dbb50ab
+size 548677
diff --git a/lib/search/indexes/github-docs-ghae-ja.json.br b/lib/search/indexes/github-docs-ghae-ja.json.br
index 02d845839e3d..b1d1277d44df 100644
--- a/lib/search/indexes/github-docs-ghae-ja.json.br
+++ b/lib/search/indexes/github-docs-ghae-ja.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:b74ddffa965633969c95e203717caf1edb6eac57ace2b4a04251b230fb6b2e71
-size 2782059
+oid sha256:fe2d41ce4311730ba85ded82b461a192ca4a189c3938072654403b9c774c35c0
+size 2783289
diff --git a/lib/search/indexes/github-docs-ghae-pt-records.json.br b/lib/search/indexes/github-docs-ghae-pt-records.json.br
index d4e27faa8e5c..048eca3f735d 100644
--- a/lib/search/indexes/github-docs-ghae-pt-records.json.br
+++ b/lib/search/indexes/github-docs-ghae-pt-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:ff20c51cffb3856c15951842d4f55b8eadec8f92ddfeb4c4e9adb8abe32de227
-size 487752
+oid sha256:0e5527aa1723b16b61f5aa64b5103857a78de92336bb19e6821a4c0340d419c5
+size 488723
diff --git a/lib/search/indexes/github-docs-ghae-pt.json.br b/lib/search/indexes/github-docs-ghae-pt.json.br
index 999d5478c0d9..e6b01ba03fa4 100644
--- a/lib/search/indexes/github-docs-ghae-pt.json.br
+++ b/lib/search/indexes/github-docs-ghae-pt.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:3f832140d69090957e6977ed90e757df25dc1a10a34e25c78ae117193a0a3b44
-size 1893896
+oid sha256:f2e329b88995f29f9018049a94e338e52497ab238215dcac2b7a0bee00cbcc89
+size 1896488
diff --git a/lib/search/indexes/github-docs-ghec-cn-records.json.br b/lib/search/indexes/github-docs-ghec-cn-records.json.br
index e9d47df8ba64..0b8c96613420 100644
--- a/lib/search/indexes/github-docs-ghec-cn-records.json.br
+++ b/lib/search/indexes/github-docs-ghec-cn-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:9030031c110f3f7d9a5ba78a4b2e5a00a6f5d36ad0b9cc98d8c27697f0ed448e
-size 840616
+oid sha256:2990faf40506710dacd7867e28c37d8fecc49512b4d15366be8f70c17f72a63d
+size 840762
diff --git a/lib/search/indexes/github-docs-ghec-cn.json.br b/lib/search/indexes/github-docs-ghec-cn.json.br
index 98972aa60407..e44be5492b54 100644
--- a/lib/search/indexes/github-docs-ghec-cn.json.br
+++ b/lib/search/indexes/github-docs-ghec-cn.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:c6c6005e63688aa1d6a311049c03bb60ee2690a750572ab5b021bf8c3a63618a
-size 1624407
+oid sha256:7e8d67427743f1cf7d603895a7918194b40b86a8cc963e69aed8f76eed323452
+size 1624751
diff --git a/lib/search/indexes/github-docs-ghec-en-records.json.br b/lib/search/indexes/github-docs-ghec-en-records.json.br
index b0b9cf59ba83..1e4da2129948 100644
--- a/lib/search/indexes/github-docs-ghec-en-records.json.br
+++ b/lib/search/indexes/github-docs-ghec-en-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:6537ef2e61f51843afbd27959a61a40b848052f303805a9a07f2bcf28c616ced
-size 1105758
+oid sha256:191acdb7584de093cf1e19944bb14e24557bebc716b564d807f6757aa7aaad15
+size 1105905
diff --git a/lib/search/indexes/github-docs-ghec-en.json.br b/lib/search/indexes/github-docs-ghec-en.json.br
index 60bede434b2f..baa68b7410b1 100644
--- a/lib/search/indexes/github-docs-ghec-en.json.br
+++ b/lib/search/indexes/github-docs-ghec-en.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:409df8f4617642fd49a785b2c178df7317bf2b77e008ca6dde48aaae18e16dae
-size 4209709
+oid sha256:3cecd19b20810cde8936b03175f2fb4b30c19e25074929b499b5d66520cfe2e5
+size 4214392
diff --git a/lib/search/indexes/github-docs-ghec-es-records.json.br b/lib/search/indexes/github-docs-ghec-es-records.json.br
index 4aa15c706ebe..077c36fc0896 100644
--- a/lib/search/indexes/github-docs-ghec-es-records.json.br
+++ b/lib/search/indexes/github-docs-ghec-es-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:926c7f0c8382b1605505454686a7272fe7192f06d216504f39c8937901a9a32b
-size 777866
+oid sha256:ea5bfd221b54734f57bfbc8315447523c265e936b49f98312a4de1c080385961
+size 777759
diff --git a/lib/search/indexes/github-docs-ghec-es.json.br b/lib/search/indexes/github-docs-ghec-es.json.br
index 24aab848fd27..c6f5d03522d5 100644
--- a/lib/search/indexes/github-docs-ghec-es.json.br
+++ b/lib/search/indexes/github-docs-ghec-es.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:20c9eafd09e07e48f004f840daf46e4f8ff0c38d0cb2adef34a80d886ed72c59
-size 3269841
+oid sha256:6c28085a8235a3bcdfd87357f6fcb3d7809c123ea10b0d3927593e3ac0965fb7
+size 3264349
diff --git a/lib/search/indexes/github-docs-ghec-ja-records.json.br b/lib/search/indexes/github-docs-ghec-ja-records.json.br
index ff705d4eab61..ee4c353b0802 100644
--- a/lib/search/indexes/github-docs-ghec-ja-records.json.br
+++ b/lib/search/indexes/github-docs-ghec-ja-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:3080b9d2f925b88c91e783c9e4f44915a1e62767c789af5d6ba2e2dd085a64e8
-size 854658
+oid sha256:483be917e74d1aa2ac49b9bc193b757669f50c001c69ca6f1fe4531b48bb36c3
+size 854637
diff --git a/lib/search/indexes/github-docs-ghec-ja.json.br b/lib/search/indexes/github-docs-ghec-ja.json.br
index 519f09495bf9..5a7fc4e55875 100644
--- a/lib/search/indexes/github-docs-ghec-ja.json.br
+++ b/lib/search/indexes/github-docs-ghec-ja.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:d13d54a2d786bdf7a40726a8dbac8ae87887913021565f4abc8346dd8eca7fff
-size 4557636
+oid sha256:39085d325411fc7224829e882df0d483de160ccb6f2a87c04eeb7e038c1da775
+size 4557321
diff --git a/lib/search/indexes/github-docs-ghec-pt-records.json.br b/lib/search/indexes/github-docs-ghec-pt-records.json.br
index f690d7561a0d..bfc5957b6eb8 100644
--- a/lib/search/indexes/github-docs-ghec-pt-records.json.br
+++ b/lib/search/indexes/github-docs-ghec-pt-records.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:616c27d185b7d159dd12aba427fbd47262c9c9337a054b9fc3360d133ea9150d
-size 766281
+oid sha256:fbcb9c7c251e982d5281c0d62594c64719d6052ba90a71f06dc467f7b5a76057
+size 766227
diff --git a/lib/search/indexes/github-docs-ghec-pt.json.br b/lib/search/indexes/github-docs-ghec-pt.json.br
index 7a569601262d..6984c87a86e3 100644
--- a/lib/search/indexes/github-docs-ghec-pt.json.br
+++ b/lib/search/indexes/github-docs-ghec-pt.json.br
@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
-oid sha256:1c6b49bda649fab0d3f5f7c51a9cf2cdeb6fa9d5c2d2162af003056799a639b6
-size 3103683
+oid sha256:4a9eafeef1dc47ee6abfa78dca2437d3b1fcedf849520447e62e262d3169ad29
+size 3102779
diff --git a/middleware/contextualizers/generic-toc.js b/middleware/contextualizers/generic-toc.js
index 175ffa1ef84d..79e23d089f14 100644
--- a/middleware/contextualizers/generic-toc.js
+++ b/middleware/contextualizers/generic-toc.js
@@ -30,16 +30,16 @@ export default async function genericToc(req, res, next) {
req.pagePath
)
- // Do not include hidden child items on a TOC page unless it's an Early Access category page.
- // We need to account for the extra 'articles' segment with Early Access as well, we don't
- // want to show hidden child items in that case.
- req.context.showHiddenTocItems =
- (req.context.page.documentType === 'category' &&
- req.context.currentPath.includes('/early-access/') &&
- !req.context.currentPath.endsWith('/articles')) ||
- (req.context.page.documentType === 'product' &&
- req.context.currentPath.includes('/early-access/') &&
- req.context.page.shortTitle === 'GitHub Insights')
+ // Only include hidden child items on a TOC page if it's an Early Access category or
+ // map topic page, not a product or 'articles' fake cagegory page (e.g., /early-access/github/articles).
+ // This is because we don't want entire EA product TOCs to be publicly browseable, but anything at the category
+ // or below level is fair game because that content is scoped to specific features.
+ const isCategoryOrMapTopic =
+ req.context.page.documentType === 'category' || req.context.page.documentType === 'mapTopic'
+ const isEarlyAccess = req.context.currentPath.includes('/early-access/')
+ const isArticlesCategory = req.context.currentPath.endsWith('/articles')
+
+ req.context.showHiddenTocItems = isCategoryOrMapTopic && isEarlyAccess && !isArticlesCategory
// Conditionally run getTocItems() recursively.
let isRecursive
@@ -77,6 +77,7 @@ async function getTocItems(pagesArray, context, isRecursive, renderIntros) {
return (
await Promise.all(
pagesArray.map(async (child) => {
+ // only include a hidden page if showHiddenTocItems is true
if (child.page.hidden && !context.showHiddenTocItems) return
return {
diff --git a/middleware/handle-errors.js b/middleware/handle-errors.js
index f27f60b43d8e..eaf2720a6d60 100644
--- a/middleware/handle-errors.js
+++ b/middleware/handle-errors.js
@@ -37,27 +37,31 @@ export default async function handleError(error, req, res, next) {
// Note, not using console.error() because it's arguably handled.
// Some tests might actually expect a 500 error.
+ const responseDone = res.headersSent || req.aborted
+
if (req.path.startsWith('/assets') || req.path.startsWith('/_next/static')) {
- // By default, Fastly will cache 404 responses unless otherwise
- // told not to.
- // See https://docs.fastly.com/en/guides/how-caching-and-cdns-work#http-status-codes-cached-by-default
- // Let's cache our 404'ing assets conservatively.
- // The Cache-Control is short, and let's use the default surrogate
- // key just in case it was a mistake.
- cacheControl(res)
- // Undo the cookie setting that CSRF sets.
- res.removeHeader('set-cookie')
- // Makes sure the surrogate key is NOT the manual one if it failed.
- // This basically unsets what was assumed in the beginning of
- // loading all the middlewares.
- setFastlySurrogateKey(res, SURROGATE_ENUMS.DEFAULT)
+ if (!responseDone) {
+ // By default, Fastly will cache 404 responses unless otherwise
+ // told not to.
+ // See https://docs.fastly.com/en/guides/how-caching-and-cdns-work#http-status-codes-cached-by-default
+ // Let's cache our 404'ing assets conservatively.
+ // The Cache-Control is short, and let's use the default surrogate
+ // key just in case it was a mistake.
+ cacheControl(res)
+ // Undo the cookie setting that CSRF sets.
+ res.removeHeader('set-cookie')
+ // Makes sure the surrogate key is NOT the manual one if it failed.
+ // This basically unsets what was assumed in the beginning of
+ // loading all the middlewares.
+ setFastlySurrogateKey(res, SURROGATE_ENUMS.DEFAULT)
+ }
} else if (process.env.NODE_ENV === 'test') {
console.warn('An error occurrred in some middleware handler', error)
}
try {
// If the headers have already been sent or the request was aborted...
- if (res.headersSent || req.aborted) {
+ if (responseDone) {
// Report to Failbot
await logException(error, req)
diff --git a/package-lock.json b/package-lock.json
index 30b32046b8c1..1c3e1926d6e5 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -63,7 +63,7 @@
"react": "^17.0.2",
"react-dom": "^17.0.2",
"react-markdown": "^8.0.0",
- "react-syntax-highlighter": "^15.4.5",
+ "react-syntax-highlighter": "^15.5.0",
"rehype-autolink-headings": "^6.1.1",
"rehype-highlight": "^5.0.2",
"rehype-raw": "^6.1.1",
@@ -111,8 +111,8 @@
"@types/react-dom": "^17.0.11",
"@types/react-syntax-highlighter": "^13.5.2",
"@types/uuid": "^8.3.4",
- "@typescript-eslint/eslint-plugin": "5.15.0",
- "@typescript-eslint/parser": "5.15.0",
+ "@typescript-eslint/eslint-plugin": "5.16.0",
+ "@typescript-eslint/parser": "5.16.0",
"async": "^3.2.3",
"babel-loader": "^8.2.3",
"babel-plugin-styled-components": "^2.0.2",
@@ -4212,14 +4212,14 @@
}
},
"node_modules/@typescript-eslint/eslint-plugin": {
- "version": "5.15.0",
- "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-5.15.0.tgz",
- "integrity": "sha512-u6Db5JfF0Esn3tiAKELvoU5TpXVSkOpZ78cEGn/wXtT2RVqs2vkt4ge6N8cRCyw7YVKhmmLDbwI2pg92mlv7cA==",
+ "version": "5.16.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-5.16.0.tgz",
+ "integrity": "sha512-SJoba1edXvQRMmNI505Uo4XmGbxCK9ARQpkvOd00anxzri9RNQk0DDCxD+LIl+jYhkzOJiOMMKYEHnHEODjdCw==",
"dev": true,
"dependencies": {
- "@typescript-eslint/scope-manager": "5.15.0",
- "@typescript-eslint/type-utils": "5.15.0",
- "@typescript-eslint/utils": "5.15.0",
+ "@typescript-eslint/scope-manager": "5.16.0",
+ "@typescript-eslint/type-utils": "5.16.0",
+ "@typescript-eslint/utils": "5.16.0",
"debug": "^4.3.2",
"functional-red-black-tree": "^1.0.1",
"ignore": "^5.1.8",
@@ -4245,14 +4245,14 @@
}
},
"node_modules/@typescript-eslint/parser": {
- "version": "5.15.0",
- "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-5.15.0.tgz",
- "integrity": "sha512-NGAYP/+RDM2sVfmKiKOCgJYPstAO40vPAgACoWPO/+yoYKSgAXIFaBKsV8P0Cc7fwKgvj27SjRNX4L7f4/jCKQ==",
+ "version": "5.16.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-5.16.0.tgz",
+ "integrity": "sha512-fkDq86F0zl8FicnJtdXakFs4lnuebH6ZADDw6CYQv0UZeIjHvmEw87m9/29nk2Dv5Lmdp0zQ3zDQhiMWQf/GbA==",
"dev": true,
"dependencies": {
- "@typescript-eslint/scope-manager": "5.15.0",
- "@typescript-eslint/types": "5.15.0",
- "@typescript-eslint/typescript-estree": "5.15.0",
+ "@typescript-eslint/scope-manager": "5.16.0",
+ "@typescript-eslint/types": "5.16.0",
+ "@typescript-eslint/typescript-estree": "5.16.0",
"debug": "^4.3.2"
},
"engines": {
@@ -4272,13 +4272,13 @@
}
},
"node_modules/@typescript-eslint/scope-manager": {
- "version": "5.15.0",
- "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-5.15.0.tgz",
- "integrity": "sha512-EFiZcSKrHh4kWk0pZaa+YNJosvKE50EnmN4IfgjkA3bTHElPtYcd2U37QQkNTqwMCS7LXeDeZzEqnsOH8chjSg==",
+ "version": "5.16.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-5.16.0.tgz",
+ "integrity": "sha512-P+Yab2Hovg8NekLIR/mOElCDPyGgFZKhGoZA901Yax6WR6HVeGLbsqJkZ+Cvk5nts/dAlFKm8PfL43UZnWdpIQ==",
"dev": true,
"dependencies": {
- "@typescript-eslint/types": "5.15.0",
- "@typescript-eslint/visitor-keys": "5.15.0"
+ "@typescript-eslint/types": "5.16.0",
+ "@typescript-eslint/visitor-keys": "5.16.0"
},
"engines": {
"node": "^12.22.0 || ^14.17.0 || >=16.0.0"
@@ -4289,12 +4289,12 @@
}
},
"node_modules/@typescript-eslint/type-utils": {
- "version": "5.15.0",
- "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-5.15.0.tgz",
- "integrity": "sha512-KGeDoEQ7gHieLydujGEFLyLofipe9PIzfvA/41urz4hv+xVxPEbmMQonKSynZ0Ks2xDhJQ4VYjB3DnRiywvKDA==",
+ "version": "5.16.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-5.16.0.tgz",
+ "integrity": "sha512-SKygICv54CCRl1Vq5ewwQUJV/8padIWvPgCxlWPGO/OgQLCijY9G7lDu6H+mqfQtbzDNlVjzVWQmeqbLMBLEwQ==",
"dev": true,
"dependencies": {
- "@typescript-eslint/utils": "5.15.0",
+ "@typescript-eslint/utils": "5.16.0",
"debug": "^4.3.2",
"tsutils": "^3.21.0"
},
@@ -4315,9 +4315,9 @@
}
},
"node_modules/@typescript-eslint/types": {
- "version": "5.15.0",
- "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-5.15.0.tgz",
- "integrity": "sha512-yEiTN4MDy23vvsIksrShjNwQl2vl6kJeG9YkVJXjXZnkJElzVK8nfPsWKYxcsGWG8GhurYXP4/KGj3aZAxbeOA==",
+ "version": "5.16.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-5.16.0.tgz",
+ "integrity": "sha512-oUorOwLj/3/3p/HFwrp6m/J2VfbLC8gjW5X3awpQJ/bSG+YRGFS4dpsvtQ8T2VNveV+LflQHjlLvB6v0R87z4g==",
"dev": true,
"engines": {
"node": "^12.22.0 || ^14.17.0 || >=16.0.0"
@@ -4328,13 +4328,13 @@
}
},
"node_modules/@typescript-eslint/typescript-estree": {
- "version": "5.15.0",
- "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-5.15.0.tgz",
- "integrity": "sha512-Hb0e3dGc35b75xLzixM3cSbG1sSbrTBQDfIScqdyvrfJZVEi4XWAT+UL/HMxEdrJNB8Yk28SKxPLtAhfCbBInA==",
+ "version": "5.16.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-5.16.0.tgz",
+ "integrity": "sha512-SE4VfbLWUZl9MR+ngLSARptUv2E8brY0luCdgmUevU6arZRY/KxYoLI/3V/yxaURR8tLRN7bmZtJdgmzLHI6pQ==",
"dev": true,
"dependencies": {
- "@typescript-eslint/types": "5.15.0",
- "@typescript-eslint/visitor-keys": "5.15.0",
+ "@typescript-eslint/types": "5.16.0",
+ "@typescript-eslint/visitor-keys": "5.16.0",
"debug": "^4.3.2",
"globby": "^11.0.4",
"is-glob": "^4.0.3",
@@ -4355,15 +4355,15 @@
}
},
"node_modules/@typescript-eslint/utils": {
- "version": "5.15.0",
- "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-5.15.0.tgz",
- "integrity": "sha512-081rWu2IPKOgTOhHUk/QfxuFog8m4wxW43sXNOMSCdh578tGJ1PAaWPsj42LOa7pguh173tNlMigsbrHvh/mtA==",
+ "version": "5.16.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-5.16.0.tgz",
+ "integrity": "sha512-iYej2ER6AwmejLWMWzJIHy3nPJeGDuCqf8Jnb+jAQVoPpmWzwQOfa9hWVB8GIQE5gsCv/rfN4T+AYb/V06WseQ==",
"dev": true,
"dependencies": {
"@types/json-schema": "^7.0.9",
- "@typescript-eslint/scope-manager": "5.15.0",
- "@typescript-eslint/types": "5.15.0",
- "@typescript-eslint/typescript-estree": "5.15.0",
+ "@typescript-eslint/scope-manager": "5.16.0",
+ "@typescript-eslint/types": "5.16.0",
+ "@typescript-eslint/typescript-estree": "5.16.0",
"eslint-scope": "^5.1.1",
"eslint-utils": "^3.0.0"
},
@@ -4397,12 +4397,12 @@
}
},
"node_modules/@typescript-eslint/visitor-keys": {
- "version": "5.15.0",
- "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-5.15.0.tgz",
- "integrity": "sha512-+vX5FKtgvyHbmIJdxMJ2jKm9z2BIlXJiuewI8dsDYMp5LzPUcuTT78Ya5iwvQg3VqSVdmxyM8Anj1Jeq7733ZQ==",
+ "version": "5.16.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-5.16.0.tgz",
+ "integrity": "sha512-jqxO8msp5vZDhikTwq9ubyMHqZ67UIvawohr4qF3KhlpL7gzSjOd+8471H3nh5LyABkaI85laEKKU8SnGUK5/g==",
"dev": true,
"dependencies": {
- "@typescript-eslint/types": "5.15.0",
+ "@typescript-eslint/types": "5.16.0",
"eslint-visitor-keys": "^3.0.0"
},
"engines": {
@@ -14888,9 +14888,9 @@
}
},
"node_modules/minimist": {
- "version": "1.2.5",
- "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz",
- "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw=="
+ "version": "1.2.6",
+ "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.6.tgz",
+ "integrity": "sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q=="
},
"node_modules/minimist-options": {
"version": "4.1.0",
@@ -17441,9 +17441,12 @@
}
},
"node_modules/prismjs": {
- "version": "1.25.0",
- "resolved": "https://registry.npmjs.org/prismjs/-/prismjs-1.25.0.tgz",
- "integrity": "sha512-WCjJHl1KEWbnkQom1+SzftbtXMKQoezOCYs5rECqMN+jP+apI7ftoflyqigqzopSO3hMhTEb0mFClA8lkolgEg=="
+ "version": "1.27.0",
+ "resolved": "https://registry.npmjs.org/prismjs/-/prismjs-1.27.0.tgz",
+ "integrity": "sha512-t13BGPUlFDR7wRB5kQDG4jjl7XeuH6jbJGt11JHPL96qwsEHNX2+68tFXqc1/k+/jALsbSWJKUOT/hcYAZ5LkA==",
+ "engines": {
+ "node": ">=6"
+ }
},
"node_modules/private": {
"version": "0.1.8",
@@ -17945,15 +17948,16 @@
}
},
"node_modules/react-syntax-highlighter": {
- "version": "15.4.5",
- "resolved": "https://registry.npmjs.org/react-syntax-highlighter/-/react-syntax-highlighter-15.4.5.tgz",
- "integrity": "sha512-RC90KQTxZ/b7+9iE6s9nmiFLFjWswUcfULi4GwVzdFVKVMQySkJWBuOmJFfjwjMVCo0IUUuJrWebNKyviKpwLQ==",
+ "version": "15.5.0",
+ "resolved": "https://registry.npmjs.org/react-syntax-highlighter/-/react-syntax-highlighter-15.5.0.tgz",
+ "integrity": "sha512-+zq2myprEnQmH5yw6Gqc8lD55QHnpKaU8TOcFeC/Lg/MQSs8UknEA0JC4nTZGFAXC2J2Hyj/ijJ7NlabyPi2gg==",
+ "license": "MIT",
"dependencies": {
"@babel/runtime": "^7.3.1",
"highlight.js": "^10.4.1",
"lowlight": "^1.17.0",
- "prismjs": "^1.25.0",
- "refractor": "^3.2.0"
+ "prismjs": "^1.27.0",
+ "refractor": "^3.6.0"
},
"peerDependencies": {
"react": ">= 0.14.0"
@@ -18146,13 +18150,13 @@
}
},
"node_modules/refractor": {
- "version": "3.5.0",
- "resolved": "https://registry.npmjs.org/refractor/-/refractor-3.5.0.tgz",
- "integrity": "sha512-QwPJd3ferTZ4cSPPjdP5bsYHMytwWYnAN5EEnLtGvkqp/FCCnGsBgxrm9EuIDnjUC3Uc/kETtvVi7fSIVC74Dg==",
+ "version": "3.6.0",
+ "resolved": "https://registry.npmjs.org/refractor/-/refractor-3.6.0.tgz",
+ "integrity": "sha512-MY9W41IOWxxk31o+YvFCNyNzdkc9M20NoZK5vq6jkv4I/uh2zkWcfudj0Q1fovjUQJrNewS9NMzeTtqPf+n5EA==",
"dependencies": {
"hastscript": "^6.0.0",
"parse-entities": "^2.0.0",
- "prismjs": "~1.25.0"
+ "prismjs": "~1.27.0"
},
"funding": {
"type": "github",
@@ -25762,14 +25766,14 @@
}
},
"@typescript-eslint/eslint-plugin": {
- "version": "5.15.0",
- "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-5.15.0.tgz",
- "integrity": "sha512-u6Db5JfF0Esn3tiAKELvoU5TpXVSkOpZ78cEGn/wXtT2RVqs2vkt4ge6N8cRCyw7YVKhmmLDbwI2pg92mlv7cA==",
+ "version": "5.16.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-5.16.0.tgz",
+ "integrity": "sha512-SJoba1edXvQRMmNI505Uo4XmGbxCK9ARQpkvOd00anxzri9RNQk0DDCxD+LIl+jYhkzOJiOMMKYEHnHEODjdCw==",
"dev": true,
"requires": {
- "@typescript-eslint/scope-manager": "5.15.0",
- "@typescript-eslint/type-utils": "5.15.0",
- "@typescript-eslint/utils": "5.15.0",
+ "@typescript-eslint/scope-manager": "5.16.0",
+ "@typescript-eslint/type-utils": "5.16.0",
+ "@typescript-eslint/utils": "5.16.0",
"debug": "^4.3.2",
"functional-red-black-tree": "^1.0.1",
"ignore": "^5.1.8",
@@ -25779,52 +25783,52 @@
}
},
"@typescript-eslint/parser": {
- "version": "5.15.0",
- "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-5.15.0.tgz",
- "integrity": "sha512-NGAYP/+RDM2sVfmKiKOCgJYPstAO40vPAgACoWPO/+yoYKSgAXIFaBKsV8P0Cc7fwKgvj27SjRNX4L7f4/jCKQ==",
+ "version": "5.16.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-5.16.0.tgz",
+ "integrity": "sha512-fkDq86F0zl8FicnJtdXakFs4lnuebH6ZADDw6CYQv0UZeIjHvmEw87m9/29nk2Dv5Lmdp0zQ3zDQhiMWQf/GbA==",
"dev": true,
"requires": {
- "@typescript-eslint/scope-manager": "5.15.0",
- "@typescript-eslint/types": "5.15.0",
- "@typescript-eslint/typescript-estree": "5.15.0",
+ "@typescript-eslint/scope-manager": "5.16.0",
+ "@typescript-eslint/types": "5.16.0",
+ "@typescript-eslint/typescript-estree": "5.16.0",
"debug": "^4.3.2"
}
},
"@typescript-eslint/scope-manager": {
- "version": "5.15.0",
- "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-5.15.0.tgz",
- "integrity": "sha512-EFiZcSKrHh4kWk0pZaa+YNJosvKE50EnmN4IfgjkA3bTHElPtYcd2U37QQkNTqwMCS7LXeDeZzEqnsOH8chjSg==",
+ "version": "5.16.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-5.16.0.tgz",
+ "integrity": "sha512-P+Yab2Hovg8NekLIR/mOElCDPyGgFZKhGoZA901Yax6WR6HVeGLbsqJkZ+Cvk5nts/dAlFKm8PfL43UZnWdpIQ==",
"dev": true,
"requires": {
- "@typescript-eslint/types": "5.15.0",
- "@typescript-eslint/visitor-keys": "5.15.0"
+ "@typescript-eslint/types": "5.16.0",
+ "@typescript-eslint/visitor-keys": "5.16.0"
}
},
"@typescript-eslint/type-utils": {
- "version": "5.15.0",
- "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-5.15.0.tgz",
- "integrity": "sha512-KGeDoEQ7gHieLydujGEFLyLofipe9PIzfvA/41urz4hv+xVxPEbmMQonKSynZ0Ks2xDhJQ4VYjB3DnRiywvKDA==",
+ "version": "5.16.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-5.16.0.tgz",
+ "integrity": "sha512-SKygICv54CCRl1Vq5ewwQUJV/8padIWvPgCxlWPGO/OgQLCijY9G7lDu6H+mqfQtbzDNlVjzVWQmeqbLMBLEwQ==",
"dev": true,
"requires": {
- "@typescript-eslint/utils": "5.15.0",
+ "@typescript-eslint/utils": "5.16.0",
"debug": "^4.3.2",
"tsutils": "^3.21.0"
}
},
"@typescript-eslint/types": {
- "version": "5.15.0",
- "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-5.15.0.tgz",
- "integrity": "sha512-yEiTN4MDy23vvsIksrShjNwQl2vl6kJeG9YkVJXjXZnkJElzVK8nfPsWKYxcsGWG8GhurYXP4/KGj3aZAxbeOA==",
+ "version": "5.16.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-5.16.0.tgz",
+ "integrity": "sha512-oUorOwLj/3/3p/HFwrp6m/J2VfbLC8gjW5X3awpQJ/bSG+YRGFS4dpsvtQ8T2VNveV+LflQHjlLvB6v0R87z4g==",
"dev": true
},
"@typescript-eslint/typescript-estree": {
- "version": "5.15.0",
- "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-5.15.0.tgz",
- "integrity": "sha512-Hb0e3dGc35b75xLzixM3cSbG1sSbrTBQDfIScqdyvrfJZVEi4XWAT+UL/HMxEdrJNB8Yk28SKxPLtAhfCbBInA==",
+ "version": "5.16.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-5.16.0.tgz",
+ "integrity": "sha512-SE4VfbLWUZl9MR+ngLSARptUv2E8brY0luCdgmUevU6arZRY/KxYoLI/3V/yxaURR8tLRN7bmZtJdgmzLHI6pQ==",
"dev": true,
"requires": {
- "@typescript-eslint/types": "5.15.0",
- "@typescript-eslint/visitor-keys": "5.15.0",
+ "@typescript-eslint/types": "5.16.0",
+ "@typescript-eslint/visitor-keys": "5.16.0",
"debug": "^4.3.2",
"globby": "^11.0.4",
"is-glob": "^4.0.3",
@@ -25833,15 +25837,15 @@
}
},
"@typescript-eslint/utils": {
- "version": "5.15.0",
- "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-5.15.0.tgz",
- "integrity": "sha512-081rWu2IPKOgTOhHUk/QfxuFog8m4wxW43sXNOMSCdh578tGJ1PAaWPsj42LOa7pguh173tNlMigsbrHvh/mtA==",
+ "version": "5.16.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-5.16.0.tgz",
+ "integrity": "sha512-iYej2ER6AwmejLWMWzJIHy3nPJeGDuCqf8Jnb+jAQVoPpmWzwQOfa9hWVB8GIQE5gsCv/rfN4T+AYb/V06WseQ==",
"dev": true,
"requires": {
"@types/json-schema": "^7.0.9",
- "@typescript-eslint/scope-manager": "5.15.0",
- "@typescript-eslint/types": "5.15.0",
- "@typescript-eslint/typescript-estree": "5.15.0",
+ "@typescript-eslint/scope-manager": "5.16.0",
+ "@typescript-eslint/types": "5.16.0",
+ "@typescript-eslint/typescript-estree": "5.16.0",
"eslint-scope": "^5.1.1",
"eslint-utils": "^3.0.0"
},
@@ -25858,12 +25862,12 @@
}
},
"@typescript-eslint/visitor-keys": {
- "version": "5.15.0",
- "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-5.15.0.tgz",
- "integrity": "sha512-+vX5FKtgvyHbmIJdxMJ2jKm9z2BIlXJiuewI8dsDYMp5LzPUcuTT78Ya5iwvQg3VqSVdmxyM8Anj1Jeq7733ZQ==",
+ "version": "5.16.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-5.16.0.tgz",
+ "integrity": "sha512-jqxO8msp5vZDhikTwq9ubyMHqZ67UIvawohr4qF3KhlpL7gzSjOd+8471H3nh5LyABkaI85laEKKU8SnGUK5/g==",
"dev": true,
"requires": {
- "@typescript-eslint/types": "5.15.0",
+ "@typescript-eslint/types": "5.16.0",
"eslint-visitor-keys": "^3.0.0"
},
"dependencies": {
@@ -33909,9 +33913,9 @@
}
},
"minimist": {
- "version": "1.2.5",
- "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz",
- "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw=="
+ "version": "1.2.6",
+ "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.6.tgz",
+ "integrity": "sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q=="
},
"minimist-options": {
"version": "4.1.0",
@@ -35900,9 +35904,9 @@
"optional": true
},
"prismjs": {
- "version": "1.25.0",
- "resolved": "https://registry.npmjs.org/prismjs/-/prismjs-1.25.0.tgz",
- "integrity": "sha512-WCjJHl1KEWbnkQom1+SzftbtXMKQoezOCYs5rECqMN+jP+apI7ftoflyqigqzopSO3hMhTEb0mFClA8lkolgEg=="
+ "version": "1.27.0",
+ "resolved": "https://registry.npmjs.org/prismjs/-/prismjs-1.27.0.tgz",
+ "integrity": "sha512-t13BGPUlFDR7wRB5kQDG4jjl7XeuH6jbJGt11JHPL96qwsEHNX2+68tFXqc1/k+/jALsbSWJKUOT/hcYAZ5LkA=="
},
"private": {
"version": "0.1.8",
@@ -36286,15 +36290,15 @@
"integrity": "sha512-X8jZHc7nCMjaCqoU+V2I0cOhNW+QMBwSUkeXnTi8IPe6zaRWfn60ZzvFDZqWPfmSJfjub7dDW1SP0jaHWLu/hg=="
},
"react-syntax-highlighter": {
- "version": "15.4.5",
- "resolved": "https://registry.npmjs.org/react-syntax-highlighter/-/react-syntax-highlighter-15.4.5.tgz",
- "integrity": "sha512-RC90KQTxZ/b7+9iE6s9nmiFLFjWswUcfULi4GwVzdFVKVMQySkJWBuOmJFfjwjMVCo0IUUuJrWebNKyviKpwLQ==",
+ "version": "15.5.0",
+ "resolved": "https://registry.npmjs.org/react-syntax-highlighter/-/react-syntax-highlighter-15.5.0.tgz",
+ "integrity": "sha512-+zq2myprEnQmH5yw6Gqc8lD55QHnpKaU8TOcFeC/Lg/MQSs8UknEA0JC4nTZGFAXC2J2Hyj/ijJ7NlabyPi2gg==",
"requires": {
"@babel/runtime": "^7.3.1",
"highlight.js": "^10.4.1",
"lowlight": "^1.17.0",
- "prismjs": "^1.25.0",
- "refractor": "^3.2.0"
+ "prismjs": "^1.27.0",
+ "refractor": "^3.6.0"
},
"dependencies": {
"highlight.js": {
@@ -36423,13 +36427,13 @@
}
},
"refractor": {
- "version": "3.5.0",
- "resolved": "https://registry.npmjs.org/refractor/-/refractor-3.5.0.tgz",
- "integrity": "sha512-QwPJd3ferTZ4cSPPjdP5bsYHMytwWYnAN5EEnLtGvkqp/FCCnGsBgxrm9EuIDnjUC3Uc/kETtvVi7fSIVC74Dg==",
+ "version": "3.6.0",
+ "resolved": "https://registry.npmjs.org/refractor/-/refractor-3.6.0.tgz",
+ "integrity": "sha512-MY9W41IOWxxk31o+YvFCNyNzdkc9M20NoZK5vq6jkv4I/uh2zkWcfudj0Q1fovjUQJrNewS9NMzeTtqPf+n5EA==",
"requires": {
"hastscript": "^6.0.0",
"parse-entities": "^2.0.0",
- "prismjs": "~1.25.0"
+ "prismjs": "~1.27.0"
},
"dependencies": {
"character-entities": {
diff --git a/package.json b/package.json
index 8a2cc8f52677..42eb8ad6fffb 100644
--- a/package.json
+++ b/package.json
@@ -11,9 +11,9 @@
"dependencies": {
"@github/failbot": "0.8.0",
"@primer/css": "^19.4.0",
- "@primer/react": "^34.7.1",
"@primer/octicons": "17.0.0",
"@primer/octicons-react": "17.0.0",
+ "@primer/react": "^34.7.1",
"@react-aria/ssr": "^3.1.0",
"accept-language-parser": "^1.5.0",
"ajv": "^8.9.0",
@@ -65,7 +65,7 @@
"react": "^17.0.2",
"react-dom": "^17.0.2",
"react-markdown": "^8.0.0",
- "react-syntax-highlighter": "^15.4.5",
+ "react-syntax-highlighter": "^15.5.0",
"rehype-autolink-headings": "^6.1.1",
"rehype-highlight": "^5.0.2",
"rehype-raw": "^6.1.1",
@@ -113,8 +113,8 @@
"@types/react-dom": "^17.0.11",
"@types/react-syntax-highlighter": "^13.5.2",
"@types/uuid": "^8.3.4",
- "@typescript-eslint/eslint-plugin": "5.15.0",
- "@typescript-eslint/parser": "5.15.0",
+ "@typescript-eslint/eslint-plugin": "5.16.0",
+ "@typescript-eslint/parser": "5.16.0",
"async": "^3.2.3",
"babel-loader": "^8.2.3",
"babel-plugin-styled-components": "^2.0.2",
diff --git a/tests/rendering/signup-button.js b/tests/rendering/signup-button.js
new file mode 100644
index 000000000000..6f3536035f8a
--- /dev/null
+++ b/tests/rendering/signup-button.js
@@ -0,0 +1,28 @@
+import { getDOM } from '../helpers/e2etest.js'
+import { describe, expect } from '@jest/globals'
+
+describe('GHEC sign up button', () => {
+ test('present by default', async () => {
+ const $ = await getDOM('/en')
+ expect($('a[href^="https://github.com/signup"]').length).toBeGreaterThan(0)
+ })
+
+ test('present on enterprise-cloud pages', async () => {
+ const $ = await getDOM('/en/enterprise-cloud@latest')
+ expect($('a[href^="https://github.com/signup"]').length).toBeGreaterThan(0)
+ })
+
+ test('not present on enterprise-server pages', async () => {
+ const $ = await getDOM('/en/enterprise-server@latest')
+ expect($('a[href^="https://github.com/signup"]').length).toBe(0)
+ })
+
+ test('not present if dotcom_user cookie', async () => {
+ const $ = await getDOM('/en', {
+ headers: {
+ cookie: 'dotcom_user=peterbe',
+ },
+ })
+ expect($('a[href^="https://github.com/signup"]').length).toBe(0)
+ })
+})