diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 4234b8f29f..04348af4ae 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -153,6 +153,15 @@ jobs: - name: Run build script run: npm run build + - name: Disk cache used by getRemoteJSON function in middleware + uses: actions/cache@9b0c1fce7a93df8e3bb8926b0d6e9d89e92f20a7 + with: + path: .remotejson-cache + # Very liberal cache key. Note, for this to become populated + # for other branches, you have to manually run this workflow + # at least once using the "Run workflow" button. + key: ${{ runner.os }}-remotejson + - name: Index fixtures into the local Elasticsearch # For the sake of saving time, only run this step if the group # is one that will run tests against an Elasticsearch on localhost. diff --git a/.gitignore b/.gitignore index 1efe6cc410..4276911e17 100644 --- a/.gitignore +++ b/.gitignore @@ -44,3 +44,6 @@ semmle-code .installed.package-lock.json assets/images/help/writing/unordered-list-rendered (1).png + +# Used by getRemoteJSON() +.remotejson-cache/ diff --git a/assets/images/enterprise/activity/activity-button.png b/assets/images/enterprise/activity/activity-button.png deleted file mode 100644 index 3216c17531..0000000000 Binary files a/assets/images/enterprise/activity/activity-button.png and /dev/null differ diff --git a/assets/images/enterprise/activity/activity-dashboard-yearly.png b/assets/images/enterprise/activity/activity-dashboard-yearly.png deleted file mode 100644 index 9a5e7a6087..0000000000 Binary files a/assets/images/enterprise/activity/activity-dashboard-yearly.png and /dev/null differ diff --git a/assets/images/enterprise/business-accounts/choose-enterprise-or-org-connect.png b/assets/images/enterprise/business-accounts/choose-enterprise-or-org-connect.png deleted file mode 100644 index 7809676de8..0000000000 Binary files a/assets/images/enterprise/business-accounts/choose-enterprise-or-org-connect.png and /dev/null differ diff --git a/assets/images/enterprise/business-accounts/confirm-disable-github-connect.png b/assets/images/enterprise/business-accounts/confirm-disable-github-connect.png deleted file mode 100644 index 2119602a49..0000000000 Binary files a/assets/images/enterprise/business-accounts/confirm-disable-github-connect.png and /dev/null differ diff --git a/assets/images/enterprise/business-accounts/disable-github-connect-button.png b/assets/images/enterprise/business-accounts/disable-github-connect-button.png deleted file mode 100644 index 8a7bc07c74..0000000000 Binary files a/assets/images/enterprise/business-accounts/disable-github-connect-button.png and /dev/null differ diff --git a/assets/images/enterprise/business-accounts/enable-github-connect-button.png b/assets/images/enterprise/business-accounts/enable-github-connect-button.png deleted file mode 100644 index a1f4191859..0000000000 Binary files a/assets/images/enterprise/business-accounts/enable-github-connect-button.png and /dev/null differ diff --git a/assets/images/enterprise/business-accounts/enable-github-pages-checkbox.png b/assets/images/enterprise/business-accounts/enable-github-pages-checkbox.png deleted file mode 100644 index d30de658ce..0000000000 Binary files a/assets/images/enterprise/business-accounts/enable-github-pages-checkbox.png and /dev/null differ diff --git a/assets/images/enterprise/business-accounts/enable-log-forwarding-checkbox.png b/assets/images/enterprise/business-accounts/enable-log-forwarding-checkbox.png deleted file mode 100644 index 2b1b20f7e5..0000000000 Binary files a/assets/images/enterprise/business-accounts/enable-log-forwarding-checkbox.png and /dev/null differ diff --git a/assets/images/enterprise/business-accounts/export-license-usage-link.png b/assets/images/enterprise/business-accounts/export-license-usage-link.png deleted file mode 100644 index 28661b9a95..0000000000 Binary files a/assets/images/enterprise/business-accounts/export-license-usage-link.png and /dev/null differ diff --git a/assets/images/enterprise/business-accounts/log-forwarding-tab.png b/assets/images/enterprise/business-accounts/log-forwarding-tab.png deleted file mode 100644 index d210ceac79..0000000000 Binary files a/assets/images/enterprise/business-accounts/log-forwarding-tab.png and /dev/null differ diff --git a/assets/images/enterprise/business-accounts/pages-policies-save-button.png b/assets/images/enterprise/business-accounts/pages-policies-save-button.png deleted file mode 100644 index 05a8f70c32..0000000000 Binary files a/assets/images/enterprise/business-accounts/pages-policies-save-button.png and /dev/null differ diff --git a/assets/images/enterprise/business-accounts/protocol-drop-down-menu.png b/assets/images/enterprise/business-accounts/protocol-drop-down-menu.png deleted file mode 100644 index e3ece9d441..0000000000 Binary files a/assets/images/enterprise/business-accounts/protocol-drop-down-menu.png and /dev/null differ diff --git a/assets/images/enterprise/business-accounts/public-certificate-text-box.png b/assets/images/enterprise/business-accounts/public-certificate-text-box.png deleted file mode 100644 index bf0e3ef647..0000000000 Binary files a/assets/images/enterprise/business-accounts/public-certificate-text-box.png and /dev/null differ diff --git a/assets/images/enterprise/business-accounts/save-button-log-forwarding.png b/assets/images/enterprise/business-accounts/save-button-log-forwarding.png deleted file mode 100644 index 6ee95178fe..0000000000 Binary files a/assets/images/enterprise/business-accounts/save-button-log-forwarding.png and /dev/null differ diff --git a/assets/images/enterprise/business-accounts/server-address-field.png b/assets/images/enterprise/business-accounts/server-address-field.png deleted file mode 100644 index c61e237706..0000000000 Binary files a/assets/images/enterprise/business-accounts/server-address-field.png and /dev/null differ diff --git a/assets/images/enterprise/business-accounts/settings-announcement-tab.png b/assets/images/enterprise/business-accounts/settings-announcement-tab.png deleted file mode 100644 index 41215dbcb4..0000000000 Binary files a/assets/images/enterprise/business-accounts/settings-announcement-tab.png and /dev/null differ diff --git a/assets/images/enterprise/business-accounts/settings-messages-tab.png b/assets/images/enterprise/business-accounts/settings-messages-tab.png deleted file mode 100644 index 68f52f739f..0000000000 Binary files a/assets/images/enterprise/business-accounts/settings-messages-tab.png and /dev/null differ diff --git a/assets/images/enterprise/business-accounts/settings-options-tab.png b/assets/images/enterprise/business-accounts/settings-options-tab.png deleted file mode 100644 index a85c306146..0000000000 Binary files a/assets/images/enterprise/business-accounts/settings-options-tab.png and /dev/null differ diff --git a/assets/images/enterprise/business-accounts/vulnerabilities-tab.png b/assets/images/enterprise/business-accounts/vulnerabilities-tab.png deleted file mode 100644 index 6ebbe879a8..0000000000 Binary files a/assets/images/enterprise/business-accounts/vulnerabilities-tab.png and /dev/null differ diff --git a/assets/images/enterprise/cluster/cluster-diagram.png b/assets/images/enterprise/cluster/cluster-diagram.png deleted file mode 100644 index 53e8c07d10..0000000000 Binary files a/assets/images/enterprise/cluster/cluster-diagram.png and /dev/null differ diff --git a/assets/images/enterprise/cluster/nagios-example.png b/assets/images/enterprise/cluster/nagios-example.png deleted file mode 100644 index 4a6c9a7224..0000000000 Binary files a/assets/images/enterprise/cluster/nagios-example.png and /dev/null differ diff --git a/assets/images/enterprise/configuration/ae-discard-email.png b/assets/images/enterprise/configuration/ae-discard-email.png deleted file mode 100644 index a8ef6a800a..0000000000 Binary files a/assets/images/enterprise/configuration/ae-discard-email.png and /dev/null differ diff --git a/assets/images/enterprise/configuration/ae-email-configure.png b/assets/images/enterprise/configuration/ae-email-configure.png deleted file mode 100644 index 6d0aed480a..0000000000 Binary files a/assets/images/enterprise/configuration/ae-email-configure.png and /dev/null differ diff --git a/assets/images/enterprise/configuration/ae-enable-email-configure.png b/assets/images/enterprise/configuration/ae-enable-email-configure.png deleted file mode 100644 index 87f59b3d44..0000000000 Binary files a/assets/images/enterprise/configuration/ae-enable-email-configure.png and /dev/null differ diff --git a/assets/images/enterprise/configuration/ae-enterprise-configuration.png b/assets/images/enterprise/configuration/ae-enterprise-configuration.png deleted file mode 100644 index 51761ac8cf..0000000000 Binary files a/assets/images/enterprise/configuration/ae-enterprise-configuration.png and /dev/null differ diff --git a/assets/images/enterprise/configuration/ae-force-pushes-configuration-menu.png b/assets/images/enterprise/configuration/ae-force-pushes-configuration-menu.png deleted file mode 100644 index 91f49b8307..0000000000 Binary files a/assets/images/enterprise/configuration/ae-force-pushes-configuration-menu.png and /dev/null differ diff --git a/assets/images/enterprise/configuration/ae-git-ssh-access-menu.png b/assets/images/enterprise/configuration/ae-git-ssh-access-menu.png deleted file mode 100644 index 77905d5c1d..0000000000 Binary files a/assets/images/enterprise/configuration/ae-git-ssh-access-menu.png and /dev/null differ diff --git a/assets/images/enterprise/configuration/ae-idp-configure.png b/assets/images/enterprise/configuration/ae-idp-configure.png deleted file mode 100644 index e851f586df..0000000000 Binary files a/assets/images/enterprise/configuration/ae-idp-configure.png and /dev/null differ diff --git a/assets/images/enterprise/configuration/ae-idp-issuer-url.png b/assets/images/enterprise/configuration/ae-idp-issuer-url.png deleted file mode 100644 index ec47f27e57..0000000000 Binary files a/assets/images/enterprise/configuration/ae-idp-issuer-url.png and /dev/null differ diff --git a/assets/images/enterprise/configuration/ae-idp-public-certificate.png b/assets/images/enterprise/configuration/ae-idp-public-certificate.png deleted file mode 100644 index 85772db116..0000000000 Binary files a/assets/images/enterprise/configuration/ae-idp-public-certificate.png and /dev/null differ diff --git a/assets/images/enterprise/configuration/ae-idp-sign-on-url.png b/assets/images/enterprise/configuration/ae-idp-sign-on-url.png deleted file mode 100644 index f475b80262..0000000000 Binary files a/assets/images/enterprise/configuration/ae-idp-sign-on-url.png and /dev/null differ diff --git a/assets/images/enterprise/configuration/ae-organization-creation-permissions-menu.png b/assets/images/enterprise/configuration/ae-organization-creation-permissions-menu.png deleted file mode 100644 index 9be4af2e09..0000000000 Binary files a/assets/images/enterprise/configuration/ae-organization-creation-permissions-menu.png and /dev/null differ diff --git a/assets/images/enterprise/configuration/ae-policies-configure.png b/assets/images/enterprise/configuration/ae-policies-configure.png deleted file mode 100644 index 278f8eec94..0000000000 Binary files a/assets/images/enterprise/configuration/ae-policies-configure.png and /dev/null differ diff --git a/assets/images/enterprise/configuration/ae-repository-creation-permissions.png b/assets/images/enterprise/configuration/ae-repository-creation-permissions.png deleted file mode 100644 index 32ca49e2ee..0000000000 Binary files a/assets/images/enterprise/configuration/ae-repository-creation-permissions.png and /dev/null differ diff --git a/assets/images/enterprise/configuration/ae-repository-forking-menu.png b/assets/images/enterprise/configuration/ae-repository-forking-menu.png deleted file mode 100644 index a1482bacec..0000000000 Binary files a/assets/images/enterprise/configuration/ae-repository-forking-menu.png and /dev/null differ diff --git a/assets/images/enterprise/configuration/ae-repository-invitations-menu.png b/assets/images/enterprise/configuration/ae-repository-invitations-menu.png deleted file mode 100644 index 9d16134638..0000000000 Binary files a/assets/images/enterprise/configuration/ae-repository-invitations-menu.png and /dev/null differ diff --git a/assets/images/enterprise/configuration/ae-repository-permissions-menu.png b/assets/images/enterprise/configuration/ae-repository-permissions-menu.png deleted file mode 100644 index e69b41c8ac..0000000000 Binary files a/assets/images/enterprise/configuration/ae-repository-permissions-menu.png and /dev/null differ diff --git a/assets/images/enterprise/configuration/ae-repository-visibility-menu.png b/assets/images/enterprise/configuration/ae-repository-visibility-menu.png deleted file mode 100644 index 934ccf0777..0000000000 Binary files a/assets/images/enterprise/configuration/ae-repository-visibility-menu.png and /dev/null differ diff --git a/assets/images/enterprise/configuration/ae-reset-default-options.png b/assets/images/enterprise/configuration/ae-reset-default-options.png deleted file mode 100644 index 0f309452ae..0000000000 Binary files a/assets/images/enterprise/configuration/ae-reset-default-options.png and /dev/null differ diff --git a/assets/images/enterprise/configuration/ae-save.png b/assets/images/enterprise/configuration/ae-save.png deleted file mode 100644 index 3240cfa2e5..0000000000 Binary files a/assets/images/enterprise/configuration/ae-save.png and /dev/null differ diff --git a/assets/images/enterprise/configuration/ae-send-test-email.png b/assets/images/enterprise/configuration/ae-send-test-email.png deleted file mode 100644 index 384e10d7c5..0000000000 Binary files a/assets/images/enterprise/configuration/ae-send-test-email.png and /dev/null differ diff --git a/assets/images/enterprise/configuration/ae-support-configure.png b/assets/images/enterprise/configuration/ae-support-configure.png deleted file mode 100644 index 783f7f101c..0000000000 Binary files a/assets/images/enterprise/configuration/ae-support-configure.png and /dev/null differ diff --git a/assets/images/enterprise/configuration/ae-support-link-url.png b/assets/images/enterprise/configuration/ae-support-link-url.png deleted file mode 100644 index f603e12a61..0000000000 Binary files a/assets/images/enterprise/configuration/ae-support-link-url.png and /dev/null differ diff --git a/assets/images/enterprise/configuration/ae-test-email.png b/assets/images/enterprise/configuration/ae-test-email.png deleted file mode 100644 index 8a02a19c4e..0000000000 Binary files a/assets/images/enterprise/configuration/ae-test-email.png and /dev/null differ diff --git a/assets/images/enterprise/configuration/ae-test-saml-configuration.png b/assets/images/enterprise/configuration/ae-test-saml-configuration.png deleted file mode 100644 index 5333171e29..0000000000 Binary files a/assets/images/enterprise/configuration/ae-test-saml-configuration.png and /dev/null differ diff --git a/assets/images/enterprise/configuration/enforce-tls-for-smtp-checkbox.png b/assets/images/enterprise/configuration/enforce-tls-for-smtp-checkbox.png index e2b4f4fcb0..57c528ebdb 100644 Binary files a/assets/images/enterprise/configuration/enforce-tls-for-smtp-checkbox.png and b/assets/images/enterprise/configuration/enforce-tls-for-smtp-checkbox.png differ diff --git a/assets/images/enterprise/configuration/enterprise-account-email-tab.png b/assets/images/enterprise/configuration/enterprise-account-email-tab.png deleted file mode 100644 index 1fa7acf0a6..0000000000 Binary files a/assets/images/enterprise/configuration/enterprise-account-email-tab.png and /dev/null differ diff --git a/assets/images/enterprise/custom-footer/add-footer-links.png b/assets/images/enterprise/custom-footer/add-footer-links.png deleted file mode 100644 index a4c40ca587..0000000000 Binary files a/assets/images/enterprise/custom-footer/add-footer-links.png and /dev/null differ diff --git a/assets/images/enterprise/custom-footer/custom-footer-section.png b/assets/images/enterprise/custom-footer/custom-footer-section.png index 7cdaf01f2d..3df6b4b10e 100644 Binary files a/assets/images/enterprise/custom-footer/custom-footer-section.png and b/assets/images/enterprise/custom-footer/custom-footer-section.png differ diff --git a/assets/images/enterprise/custom-footer/enterprise-profile-ghec.png b/assets/images/enterprise/custom-footer/enterprise-profile-ghec.png deleted file mode 100644 index b7a386193c..0000000000 Binary files a/assets/images/enterprise/custom-footer/enterprise-profile-ghec.png and /dev/null differ diff --git a/assets/images/enterprise/custom-footer/enterprise-profile-ghes.png b/assets/images/enterprise/custom-footer/enterprise-profile-ghes.png deleted file mode 100644 index 5232af1895..0000000000 Binary files a/assets/images/enterprise/custom-footer/enterprise-profile-ghes.png and /dev/null differ diff --git a/assets/images/enterprise/custom-footer/octodemo-footer.png b/assets/images/enterprise/custom-footer/octodemo-footer.png deleted file mode 100644 index f7915b7d0e..0000000000 Binary files a/assets/images/enterprise/custom-footer/octodemo-footer.png and /dev/null differ diff --git a/assets/images/enterprise/custom-footer/update-custom-footer.png b/assets/images/enterprise/custom-footer/update-custom-footer.png deleted file mode 100644 index 2222bbf014..0000000000 Binary files a/assets/images/enterprise/custom-footer/update-custom-footer.png and /dev/null differ diff --git a/assets/images/enterprise/enterprise-server/license.png b/assets/images/enterprise/enterprise-server/license.png deleted file mode 100644 index a948c3d3b2..0000000000 Binary files a/assets/images/enterprise/enterprise-server/license.png and /dev/null differ diff --git a/assets/images/enterprise/github-ae/disable-github-connect-button.png b/assets/images/enterprise/github-ae/disable-github-connect-button.png deleted file mode 100644 index c343435180..0000000000 Binary files a/assets/images/enterprise/github-ae/disable-github-connect-button.png and /dev/null differ diff --git a/assets/images/enterprise/github-ae/enable-github-connect-button.png b/assets/images/enterprise/github-ae/enable-github-connect-button.png deleted file mode 100644 index e79e36b835..0000000000 Binary files a/assets/images/enterprise/github-ae/enable-github-connect-button.png and /dev/null differ diff --git a/assets/images/enterprise/graphs/click-alert-in-alerts-list.png b/assets/images/enterprise/graphs/click-alert-in-alerts-list.png deleted file mode 100644 index 0339c25069..0000000000 Binary files a/assets/images/enterprise/graphs/click-alert-in-alerts-list.png and /dev/null differ diff --git a/assets/images/enterprise/maintenance/enable-ip-exception-list.png b/assets/images/enterprise/maintenance/enable-ip-exception-list.png deleted file mode 100644 index 9b9b1881f1..0000000000 Binary files a/assets/images/enterprise/maintenance/enable-ip-exception-list.png and /dev/null differ diff --git a/assets/images/enterprise/maintenance/enable-maintenance-mode-checkbox.png b/assets/images/enterprise/maintenance/enable-maintenance-mode-checkbox.png deleted file mode 100644 index 8dea941acb..0000000000 Binary files a/assets/images/enterprise/maintenance/enable-maintenance-mode-checkbox.png and /dev/null differ diff --git a/assets/images/enterprise/maintenance/enable-maintenance-mode-now.png b/assets/images/enterprise/maintenance/enable-maintenance-mode-now.png deleted file mode 100644 index ad95e43778..0000000000 Binary files a/assets/images/enterprise/maintenance/enable-maintenance-mode-now.png and /dev/null differ diff --git a/assets/images/enterprise/maintenance/ip-exception-list-ip-addresses.png b/assets/images/enterprise/maintenance/ip-exception-list-ip-addresses.png deleted file mode 100644 index 8c87b020cc..0000000000 Binary files a/assets/images/enterprise/maintenance/ip-exception-list-ip-addresses.png and /dev/null differ diff --git a/assets/images/enterprise/maintenance/ip-exception-save.png b/assets/images/enterprise/maintenance/ip-exception-save.png deleted file mode 100644 index 5f1650a0b4..0000000000 Binary files a/assets/images/enterprise/maintenance/ip-exception-save.png and /dev/null differ diff --git a/assets/images/enterprise/maintenance/maintenance-mode-maintenance-page.png b/assets/images/enterprise/maintenance/maintenance-mode-maintenance-page.png deleted file mode 100644 index d18f0bb758..0000000000 Binary files a/assets/images/enterprise/maintenance/maintenance-mode-maintenance-page.png and /dev/null differ diff --git a/assets/images/enterprise/maintenance/maintenance-scheduled.png b/assets/images/enterprise/maintenance/maintenance-scheduled.png deleted file mode 100644 index 4135e9e8bd..0000000000 Binary files a/assets/images/enterprise/maintenance/maintenance-scheduled.png and /dev/null differ diff --git a/assets/images/enterprise/maintenance/schedule-maintenance-mode-two-hours.png b/assets/images/enterprise/maintenance/schedule-maintenance-mode-two-hours.png deleted file mode 100644 index 0fb3cf097a..0000000000 Binary files a/assets/images/enterprise/maintenance/schedule-maintenance-mode-two-hours.png and /dev/null differ diff --git a/assets/images/enterprise/management-console/export-license-usage-link.png b/assets/images/enterprise/management-console/export-license-usage-link.png new file mode 100644 index 0000000000..105cd3d9f0 Binary files /dev/null and b/assets/images/enterprise/management-console/export-license-usage-link.png differ diff --git a/assets/images/enterprise/settings/ent-new-explore.png b/assets/images/enterprise/settings/ent-new-explore.png index c1c2d72f31..b813f0b81d 100644 Binary files a/assets/images/enterprise/settings/ent-new-explore.png and b/assets/images/enterprise/settings/ent-new-explore.png differ diff --git a/assets/images/help/actions/environments-sidebar.png b/assets/images/help/actions/environments-sidebar.png deleted file mode 100644 index 65f1b84ec3..0000000000 Binary files a/assets/images/help/actions/environments-sidebar.png and /dev/null differ diff --git a/assets/images/help/enterprises/enterprise-licensing-tab.png b/assets/images/help/enterprises/enterprise-licensing-tab.png deleted file mode 100644 index f66c98c88d..0000000000 Binary files a/assets/images/help/enterprises/enterprise-licensing-tab.png and /dev/null differ diff --git a/assets/images/help/sponsors/link-account-button.png b/assets/images/help/sponsors/link-account-button.png deleted file mode 100644 index b23c080276..0000000000 Binary files a/assets/images/help/sponsors/link-account-button.png and /dev/null differ diff --git a/assets/images/help/sponsors/new-update-button.png b/assets/images/help/sponsors/new-update-button.png deleted file mode 100644 index 81885bdf39..0000000000 Binary files a/assets/images/help/sponsors/new-update-button.png and /dev/null differ diff --git a/assets/images/help/sponsors/pay-full-amount-link.png b/assets/images/help/sponsors/pay-full-amount-link.png new file mode 100644 index 0000000000..f85f63580b Binary files /dev/null and b/assets/images/help/sponsors/pay-full-amount-link.png differ diff --git a/assets/images/help/sponsors/pay-prorated-amount-link.png b/assets/images/help/sponsors/pay-prorated-amount-link.png deleted file mode 100644 index 5d1c615b1e..0000000000 Binary files a/assets/images/help/sponsors/pay-prorated-amount-link.png and /dev/null differ diff --git a/assets/images/help/sponsors/select-highlighted-org-members.png b/assets/images/help/sponsors/select-highlighted-org-members.png index 47bf785e34..d300365e66 100644 Binary files a/assets/images/help/sponsors/select-highlighted-org-members.png and b/assets/images/help/sponsors/select-highlighted-org-members.png differ diff --git a/assets/images/help/sponsors/select-tiers-email.png b/assets/images/help/sponsors/select-tiers-email.png deleted file mode 100644 index 4b7d21ea2a..0000000000 Binary files a/assets/images/help/sponsors/select-tiers-email.png and /dev/null differ diff --git a/assets/images/help/sponsors/set-a-goal-button.png b/assets/images/help/sponsors/set-a-goal-button.png deleted file mode 100644 index 13bdcad4b2..0000000000 Binary files a/assets/images/help/sponsors/set-a-goal-button.png and /dev/null differ diff --git a/assets/images/help/sponsors/settings-tab.png b/assets/images/help/sponsors/settings-tab.png deleted file mode 100644 index ce98544d47..0000000000 Binary files a/assets/images/help/sponsors/settings-tab.png and /dev/null differ diff --git a/assets/images/help/sponsors/show-one-time-tiers.png b/assets/images/help/sponsors/show-one-time-tiers.png deleted file mode 100644 index 197e5b32ee..0000000000 Binary files a/assets/images/help/sponsors/show-one-time-tiers.png and /dev/null differ diff --git a/assets/images/help/sponsors/sponsor-as-drop-down-menu.png b/assets/images/help/sponsors/sponsor-as-drop-down-menu.png deleted file mode 100644 index 9df32d3db3..0000000000 Binary files a/assets/images/help/sponsors/sponsor-as-drop-down-menu.png and /dev/null differ diff --git a/assets/images/help/sponsors/sponsor-developer-button.png b/assets/images/help/sponsors/sponsor-developer-button.png deleted file mode 100644 index a032ecf75d..0000000000 Binary files a/assets/images/help/sponsors/sponsor-developer-button.png and /dev/null differ diff --git a/assets/images/help/sponsors/sponsor-org-button.png b/assets/images/help/sponsors/sponsor-org-button.png deleted file mode 100644 index 4efa0dab50..0000000000 Binary files a/assets/images/help/sponsors/sponsor-org-button.png and /dev/null differ diff --git a/assets/images/help/sponsors/sponsor-set-up-button.png b/assets/images/help/sponsors/sponsor-set-up-button.png deleted file mode 100644 index e7677aab97..0000000000 Binary files a/assets/images/help/sponsors/sponsor-set-up-button.png and /dev/null differ diff --git a/assets/images/help/sponsors/sponsor-tiers-tab.png b/assets/images/help/sponsors/sponsor-tiers-tab.png deleted file mode 100644 index 49c43d2114..0000000000 Binary files a/assets/images/help/sponsors/sponsor-tiers-tab.png and /dev/null differ diff --git a/assets/images/help/sponsors/sponsoring-as-drop-down-menu.png b/assets/images/help/sponsors/sponsoring-as-drop-down-menu.png deleted file mode 100644 index 39c2c65a72..0000000000 Binary files a/assets/images/help/sponsors/sponsoring-as-drop-down-menu.png and /dev/null differ diff --git a/assets/images/help/sponsors/sponsoring-tab.png b/assets/images/help/sponsors/sponsoring-tab.png index 5189ba48bb..b9dea3f54e 100644 Binary files a/assets/images/help/sponsors/sponsoring-tab.png and b/assets/images/help/sponsors/sponsoring-tab.png differ diff --git a/assets/images/help/sponsors/sponsors-search-options.png b/assets/images/help/sponsors/sponsors-search-options.png deleted file mode 100644 index 54933f2dc3..0000000000 Binary files a/assets/images/help/sponsors/sponsors-search-options.png and /dev/null differ diff --git a/assets/images/help/sponsors/sponsorships-checkbox.png b/assets/images/help/sponsors/sponsorships-checkbox.png deleted file mode 100644 index 6f77373cba..0000000000 Binary files a/assets/images/help/sponsors/sponsorships-checkbox.png and /dev/null differ diff --git a/assets/images/help/sponsors/sponsorships-published-checkbox.png b/assets/images/help/sponsors/sponsorships-published-checkbox.png deleted file mode 100644 index d874f30d1e..0000000000 Binary files a/assets/images/help/sponsors/sponsorships-published-checkbox.png and /dev/null differ diff --git a/assets/images/help/sponsors/subject-body-update.png b/assets/images/help/sponsors/subject-body-update.png deleted file mode 100644 index b6ee6d29f0..0000000000 Binary files a/assets/images/help/sponsors/subject-body-update.png and /dev/null differ diff --git a/assets/images/help/sponsors/tier-editor-button.png b/assets/images/help/sponsors/tier-editor-button.png deleted file mode 100644 index 53b70e0c04..0000000000 Binary files a/assets/images/help/sponsors/tier-editor-button.png and /dev/null differ diff --git a/assets/images/help/sponsors/tier-price-description.png b/assets/images/help/sponsors/tier-price-description.png deleted file mode 100644 index a99595bad7..0000000000 Binary files a/assets/images/help/sponsors/tier-price-description.png and /dev/null differ diff --git a/assets/images/help/sponsors/unpublish-profile-button.png b/assets/images/help/sponsors/unpublish-profile-button.png deleted file mode 100644 index 559bd55aaa..0000000000 Binary files a/assets/images/help/sponsors/unpublish-profile-button.png and /dev/null differ diff --git a/assets/images/help/sponsors/unpublish-profile-dialog.png b/assets/images/help/sponsors/unpublish-profile-dialog.png deleted file mode 100644 index f751c627a1..0000000000 Binary files a/assets/images/help/sponsors/unpublish-profile-dialog.png and /dev/null differ diff --git a/assets/images/help/sponsors/update-sponsorship-button.png b/assets/images/help/sponsors/update-sponsorship-button.png deleted file mode 100644 index 00f7916dde..0000000000 Binary files a/assets/images/help/sponsors/update-sponsorship-button.png and /dev/null differ diff --git a/assets/images/help/sponsors/update-tier-button.png b/assets/images/help/sponsors/update-tier-button.png deleted file mode 100644 index b884f895c5..0000000000 Binary files a/assets/images/help/sponsors/update-tier-button.png and /dev/null differ diff --git a/assets/images/help/sponsors/updates-checkbox-manage.png b/assets/images/help/sponsors/updates-checkbox-manage.png deleted file mode 100644 index 8a6613c8af..0000000000 Binary files a/assets/images/help/sponsors/updates-checkbox-manage.png and /dev/null differ diff --git a/assets/images/help/sponsors/user-waitlist-payout-options.png b/assets/images/help/sponsors/user-waitlist-payout-options.png deleted file mode 100644 index f1addfa808..0000000000 Binary files a/assets/images/help/sponsors/user-waitlist-payout-options.png and /dev/null differ diff --git a/assets/images/help/sponsors/webhook-active.png b/assets/images/help/sponsors/webhook-active.png deleted file mode 100644 index 12bc8a167c..0000000000 Binary files a/assets/images/help/sponsors/webhook-active.png and /dev/null differ diff --git a/assets/images/help/sponsors/webhook-content-menu.png b/assets/images/help/sponsors/webhook-content-menu.png deleted file mode 100644 index 13a0f3c081..0000000000 Binary files a/assets/images/help/sponsors/webhook-content-menu.png and /dev/null differ diff --git a/assets/images/help/sponsors/webhook-edit-delete-button.png b/assets/images/help/sponsors/webhook-edit-delete-button.png deleted file mode 100644 index 4d64e22684..0000000000 Binary files a/assets/images/help/sponsors/webhook-edit-delete-button.png and /dev/null differ diff --git a/assets/images/help/sponsors/webhook-payload-url.png b/assets/images/help/sponsors/webhook-payload-url.png deleted file mode 100644 index cc4a661691..0000000000 Binary files a/assets/images/help/sponsors/webhook-payload-url.png and /dev/null differ diff --git a/assets/images/help/sponsors/webhook-secret-token.png b/assets/images/help/sponsors/webhook-secret-token.png deleted file mode 100644 index 8ff7dd7151..0000000000 Binary files a/assets/images/help/sponsors/webhook-secret-token.png and /dev/null differ diff --git a/assets/images/help/sponsors/webhooks-tab.png b/assets/images/help/sponsors/webhooks-tab.png index 78db022082..81c02d7992 100644 Binary files a/assets/images/help/sponsors/webhooks-tab.png and b/assets/images/help/sponsors/webhooks-tab.png differ diff --git a/assets/images/help/sponsors/who-can-see-sponsorship.png b/assets/images/help/sponsors/who-can-see-sponsorship.png deleted file mode 100644 index 8710355065..0000000000 Binary files a/assets/images/help/sponsors/who-can-see-sponsorship.png and /dev/null differ diff --git a/assets/images/help/sponsors/your-goals-tab.png b/assets/images/help/sponsors/your-goals-tab.png index 31993b59c6..2a95baacfb 100644 Binary files a/assets/images/help/sponsors/your-goals-tab.png and b/assets/images/help/sponsors/your-goals-tab.png differ diff --git a/assets/images/help/sponsors/your-sponsors-tab.png b/assets/images/help/sponsors/your-sponsors-tab.png index 9fadc21105..e62d3728e2 100644 Binary files a/assets/images/help/sponsors/your-sponsors-tab.png and b/assets/images/help/sponsors/your-sponsors-tab.png differ diff --git a/components/search/SearchResults.tsx b/components/search/SearchResults.tsx index 695857e5a4..f45aed8781 100644 --- a/components/search/SearchResults.tsx +++ b/components/search/SearchResults.tsx @@ -25,7 +25,7 @@ export function SearchResults({ results, query }: Props) { return (
The property to sort the results by. created means when the repository was starred. updated means when the repository was last pushed to.
The property to sort the results by.
", "in": "query", "required": false, "schema": { @@ -113534,7 +113534,7 @@ }, { "name": "sort", - "description": "The property to sort the results by. created means when the repository was starred. updated means when the repository was last pushed to.
The property to sort the results by.
", "in": "query", "required": false, "schema": { @@ -157209,7 +157209,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", "in": "query", "required": false, "schema": { @@ -157218,7 +157218,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", "in": "query", "required": false, "schema": { @@ -223217,7 +223217,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", "in": "query", "required": false, "schema": { @@ -223226,7 +223226,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", "in": "query", "required": false, "schema": { @@ -224964,7 +224964,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", "in": "query", "required": false, "schema": { @@ -224973,7 +224973,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", "in": "query", "required": false, "schema": { @@ -226752,7 +226752,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", "in": "query", "required": false, "schema": { @@ -226761,7 +226761,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", "in": "query", "required": false, "schema": { @@ -291299,7 +291299,7 @@ }, { "name": "sort", - "description": "The property to sort the results by. created means when the repository was starred. updated means when the repository was last pushed to.
The property to sort the results by.
", "in": "query", "required": false, "schema": { @@ -354159,7 +354159,7 @@ } ], "previews": [], - "descriptionHTML": "Lists all organizations, in the order that they were created on GitHub.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
Lists all organizations, in the order that they were created on GitHub.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "202", + "contentType": "application/json", + "description": "Accepted
", + "example": null, + "schema": { + "type": "object" + } + } + } + ], + "previews": [], + "descriptionHTML": "Deletes an organization and all its repositories.
\nThe organization login will be unavailable for 90 days after deletion.
\nPlease review the Terms of Service regarding account deletion before using this endpoint:
\nhttps://docs.github.com/site-policy/github-terms/github-terms-of-service
", + "statusCodes": [ + { + "httpStatusCode": "202", + "description": "Accepted
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -410695,7 +410753,7 @@ }, { "name": "sort", - "description": "The property to sort the results by. created means when the repository was starred. updated means when the repository was last pushed to.
The property to sort the results by.
", "in": "query", "required": false, "schema": { @@ -464145,7 +464203,7 @@ } ], "previews": [], - "descriptionHTML": "Lists all public repositories in the order that they were created.
\nNote:
\nsince parameter. Use the Link header to get the URL for the next page of repositories.Lists all public repositories in the order that they were created.
\nNote:
\nsince parameter. Use the Link header to get the URL for the next page of repositories.A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", "in": "query", "required": false, "schema": { @@ -488303,7 +488361,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", "in": "query", "required": false, "schema": { @@ -489645,7 +489703,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.
", "in": "query", "required": false, "schema": { @@ -489654,7 +489712,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.
", "in": "query", "required": false, "schema": { @@ -491005,7 +491063,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.
", "in": "query", "required": false, "schema": { @@ -491014,7 +491072,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.
", "in": "query", "required": false, "schema": { @@ -520972,7 +521030,7 @@ } ], "previews": [], - "descriptionHTML": "Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.
Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.
A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", "in": "query", "required": false, "schema": { @@ -110640,7 +110640,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", "in": "query", "required": false, "schema": { @@ -146666,7 +146666,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", "in": "query", "required": false, "schema": { @@ -146675,7 +146675,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", "in": "query", "required": false, "schema": { @@ -199240,7 +199240,7 @@ }, { "name": "sort", - "description": "The property to sort the results by. created means when the repository was starred. updated means when the repository was last pushed to.
The property to sort the results by.
", "in": "query", "required": false, "schema": { @@ -256253,7 +256253,7 @@ } ], "previews": [], - "descriptionHTML": "Lists all organizations, in the order that they were created on GitHub AE.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
Lists all organizations, in the order that they were created on GitHub AE.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", "in": "query", "required": false, "schema": { @@ -257588,7 +257588,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", "in": "query", "required": false, "schema": { @@ -293211,7 +293211,7 @@ }, { "name": "sort", - "description": "The property to sort the results by. created means when the repository was starred. updated means when the repository was last pushed to.
The property to sort the results by.
", "in": "query", "required": false, "schema": { @@ -365786,7 +365786,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", "in": "query", "required": false, "schema": { @@ -365795,7 +365795,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", "in": "query", "required": false, "schema": { @@ -396128,7 +396128,7 @@ } ], "previews": [], - "descriptionHTML": "Lists all users, in the order that they signed up on GitHub AE. This list includes personal user accounts and organization accounts.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.
Lists all users, in the order that they signed up on GitHub AE. This list includes personal user accounts and organization accounts.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.
The property to sort the results by. created means when the repository was starred. updated means when the repository was last pushed to.
The property to sort the results by.
", "in": "query", "required": false, "schema": { @@ -123400,7 +123400,7 @@ }, { "name": "sort", - "description": "The property to sort the results by. created means when the repository was starred. updated means when the repository was last pushed to.
The property to sort the results by.
", "in": "query", "required": false, "schema": { @@ -167239,7 +167239,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", "in": "query", "required": false, "schema": { @@ -167248,7 +167248,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", "in": "query", "required": false, "schema": { @@ -168644,7 +168644,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", "in": "query", "required": false, "schema": { @@ -168653,7 +168653,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", "in": "query", "required": false, "schema": { @@ -234652,7 +234652,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", "in": "query", "required": false, "schema": { @@ -234661,7 +234661,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", "in": "query", "required": false, "schema": { @@ -236399,7 +236399,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", "in": "query", "required": false, "schema": { @@ -236408,7 +236408,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", "in": "query", "required": false, "schema": { @@ -238187,7 +238187,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", "in": "query", "required": false, "schema": { @@ -238196,7 +238196,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", "in": "query", "required": false, "schema": { @@ -253709,7 +253709,7 @@ }, { "name": "date_start", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", "in": "query", "required": false, "schema": { @@ -253718,7 +253718,7 @@ }, { "name": "date_end", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", "in": "query", "required": false, "schema": { @@ -254076,7 +254076,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", "in": "query", "required": false, "schema": { @@ -254085,7 +254085,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", "in": "query", "required": false, "schema": { @@ -304486,7 +304486,7 @@ }, { "name": "sort", - "description": "The property to sort the results by. created means when the repository was starred. updated means when the repository was last pushed to.
The property to sort the results by.
", "in": "query", "required": false, "schema": { @@ -367346,7 +367346,7 @@ } ], "previews": [], - "descriptionHTML": "Lists all organizations, in the order that they were created on GitHub Enterprise Cloud.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
Lists all organizations, in the order that they were created on GitHub Enterprise Cloud.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "202", + "contentType": "application/json", + "description": "Accepted
", + "example": null, + "schema": { + "type": "object" + } + } + } + ], + "previews": [], + "descriptionHTML": "Deletes an organization and all its repositories.
\nThe organization login will be unavailable for 90 days after deletion.
\nPlease review the Terms of Service regarding account deletion before using this endpoint:
\nhttps://docs.github.com/enterprise-cloud@latest//site-policy/github-terms/github-terms-of-service
", + "statusCodes": [ + { + "httpStatusCode": "202", + "description": "Accepted
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -371972,7 +372030,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", "in": "query", "required": false, "schema": { @@ -371981,7 +372039,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", "in": "query", "required": false, "schema": { @@ -427415,7 +427473,7 @@ }, { "name": "sort", - "description": "The property to sort the results by. created means when the repository was starred. updated means when the repository was last pushed to.
The property to sort the results by.
", "in": "query", "required": false, "schema": { @@ -480823,7 +480881,7 @@ } ], "previews": [], - "descriptionHTML": "Lists all public repositories in the order that they were created.
\nNote:
\nsince parameter. Use the Link header to get the URL for the next page of repositories.Lists all public repositories in the order that they were created.
\nNote:
\nsince parameter. Use the Link header to get the URL for the next page of repositories.A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", "in": "query", "required": false, "schema": { @@ -507467,7 +507525,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", "in": "query", "required": false, "schema": { @@ -508809,7 +508867,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.
", "in": "query", "required": false, "schema": { @@ -508818,7 +508876,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.
", "in": "query", "required": false, "schema": { @@ -510169,7 +510227,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.
", "in": "query", "required": false, "schema": { @@ -510178,7 +510236,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.
", "in": "query", "required": false, "schema": { @@ -541704,7 +541762,7 @@ } ], "previews": [], - "descriptionHTML": "Lists all users, in the order that they signed up on GitHub Enterprise Cloud. This list includes personal user accounts and organization accounts.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.
Lists all users, in the order that they signed up on GitHub Enterprise Cloud. This list includes personal user accounts and organization accounts.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.
A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", "in": "query", "required": false, "schema": { @@ -174997,7 +174997,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", "in": "query", "required": false, "schema": { @@ -231720,7 +231720,7 @@ }, { "name": "sort", - "description": "The property to sort the results by. created means when the repository was starred. updated means when the repository was last pushed to.
The property to sort the results by.
", "in": "query", "required": false, "schema": { @@ -296173,7 +296173,7 @@ } ], "previews": [], - "descriptionHTML": "Lists all organizations, in the order that they were created on GitHub Enterprise Server.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
Lists all organizations, in the order that they were created on GitHub Enterprise Server.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", "in": "query", "required": false, "schema": { @@ -297317,7 +297317,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", "in": "query", "required": false, "schema": { @@ -333431,7 +333431,7 @@ }, { "name": "sort", - "description": "The property to sort the results by. created means when the repository was starred. updated means when the repository was last pushed to.
The property to sort the results by.
", "in": "query", "required": false, "schema": { @@ -385099,7 +385099,7 @@ } ], "previews": [], - "descriptionHTML": "Lists all public repositories in the order that they were created.
\nNote:
\nsince parameter. Use the Link header to get the URL for the next page of repositories.Lists all public repositories in the order that they were created.
\nNote:
\nsince parameter. Use the Link header to get the URL for the next page of repositories.A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", "in": "query", "required": false, "schema": { @@ -408019,7 +408019,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", "in": "query", "required": false, "schema": { @@ -438468,7 +438468,7 @@ } ], "previews": [], - "descriptionHTML": "Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.
Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.
A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", "in": "query", "required": false, "schema": { @@ -144005,7 +144005,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", "in": "query", "required": false, "schema": { @@ -182146,7 +182146,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", "in": "query", "required": false, "schema": { @@ -182155,7 +182155,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", "in": "query", "required": false, "schema": { @@ -238878,7 +238878,7 @@ }, { "name": "sort", - "description": "The property to sort the results by. created means when the repository was starred. updated means when the repository was last pushed to.
The property to sort the results by.
", "in": "query", "required": false, "schema": { @@ -303343,7 +303343,7 @@ } ], "previews": [], - "descriptionHTML": "Lists all organizations, in the order that they were created on GitHub Enterprise Server.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
Lists all organizations, in the order that they were created on GitHub Enterprise Server.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", "in": "query", "required": false, "schema": { @@ -304487,7 +304487,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", "in": "query", "required": false, "schema": { @@ -340601,7 +340601,7 @@ }, { "name": "sort", - "description": "The property to sort the results by. created means when the repository was starred. updated means when the repository was last pushed to.
The property to sort the results by.
", "in": "query", "required": false, "schema": { @@ -392394,7 +392394,7 @@ } ], "previews": [], - "descriptionHTML": "Lists all public repositories in the order that they were created.
\nNote:
\nsince parameter. Use the Link header to get the URL for the next page of repositories.Lists all public repositories in the order that they were created.
\nNote:
\nsince parameter. Use the Link header to get the URL for the next page of repositories.A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", "in": "query", "required": false, "schema": { @@ -415645,7 +415645,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", "in": "query", "required": false, "schema": { @@ -446144,7 +446144,7 @@ } ], "previews": [], - "descriptionHTML": "Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.
Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.
A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", "in": "query", "required": false, "schema": { @@ -146552,7 +146552,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", "in": "query", "required": false, "schema": { @@ -185184,7 +185184,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", "in": "query", "required": false, "schema": { @@ -185193,7 +185193,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", "in": "query", "required": false, "schema": { @@ -247951,7 +247951,7 @@ }, { "name": "sort", - "description": "The property to sort the results by. created means when the repository was starred. updated means when the repository was last pushed to.
The property to sort the results by.
", "in": "query", "required": false, "schema": { @@ -313084,7 +313084,7 @@ } ], "previews": [], - "descriptionHTML": "Lists all organizations, in the order that they were created on GitHub Enterprise Server.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
Lists all organizations, in the order that they were created on GitHub Enterprise Server.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", "in": "query", "required": false, "schema": { @@ -314249,7 +314249,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", "in": "query", "required": false, "schema": { @@ -350545,7 +350545,7 @@ }, { "name": "sort", - "description": "The property to sort the results by. created means when the repository was starred. updated means when the repository was last pushed to.
The property to sort the results by.
", "in": "query", "required": false, "schema": { @@ -403465,7 +403465,7 @@ } ], "previews": [], - "descriptionHTML": "Lists all public repositories in the order that they were created.
\nNote:
\nsince parameter. Use the Link header to get the URL for the next page of repositories.Lists all public repositories in the order that they were created.
\nNote:
\nsince parameter. Use the Link header to get the URL for the next page of repositories.A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", "in": "query", "required": false, "schema": { @@ -427326,7 +427326,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", "in": "query", "required": false, "schema": { @@ -459796,7 +459796,7 @@ } ], "previews": [], - "descriptionHTML": "Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.
Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.
A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", "in": "query", "required": false, "schema": { @@ -147538,7 +147538,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", "in": "query", "required": false, "schema": { @@ -148934,7 +148934,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", "in": "query", "required": false, "schema": { @@ -148943,7 +148943,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", "in": "query", "required": false, "schema": { @@ -187993,7 +187993,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", "in": "query", "required": false, "schema": { @@ -188002,7 +188002,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", "in": "query", "required": false, "schema": { @@ -250852,7 +250852,7 @@ }, { "name": "sort", - "description": "The property to sort the results by. created means when the repository was starred. updated means when the repository was last pushed to.
The property to sort the results by.
", "in": "query", "required": false, "schema": { @@ -316055,7 +316055,7 @@ } ], "previews": [], - "descriptionHTML": "Lists all organizations, in the order that they were created on GitHub Enterprise Server.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
Lists all organizations, in the order that they were created on GitHub Enterprise Server.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", "in": "query", "required": false, "schema": { @@ -317352,7 +317352,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", "in": "query", "required": false, "schema": { @@ -354175,7 +354175,7 @@ }, { "name": "sort", - "description": "The property to sort the results by. created means when the repository was starred. updated means when the repository was last pushed to.
The property to sort the results by.
", "in": "query", "required": false, "schema": { @@ -407219,7 +407219,7 @@ } ], "previews": [], - "descriptionHTML": "Lists all public repositories in the order that they were created.
\nNote:
\nsince parameter. Use the Link header to get the URL for the next page of repositories.Lists all public repositories in the order that they were created.
\nNote:
\nsince parameter. Use the Link header to get the URL for the next page of repositories.A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", "in": "query", "required": false, "schema": { @@ -431188,7 +431188,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", "in": "query", "required": false, "schema": { @@ -432521,7 +432521,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.
", "in": "query", "required": false, "schema": { @@ -432530,7 +432530,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.
", "in": "query", "required": false, "schema": { @@ -433872,7 +433872,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.
", "in": "query", "required": false, "schema": { @@ -433881,7 +433881,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.
", "in": "query", "required": false, "schema": { @@ -463716,7 +463716,7 @@ } ], "previews": [], - "descriptionHTML": "Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.
Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.
A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", "in": "query", "required": false, "schema": { @@ -162827,7 +162827,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", "in": "query", "required": false, "schema": { @@ -164223,7 +164223,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", "in": "query", "required": false, "schema": { @@ -164232,7 +164232,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", "in": "query", "required": false, "schema": { @@ -189820,7 +189820,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", "in": "query", "required": false, "schema": { @@ -189829,7 +189829,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", "in": "query", "required": false, "schema": { @@ -191567,7 +191567,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", "in": "query", "required": false, "schema": { @@ -191576,7 +191576,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", "in": "query", "required": false, "schema": { @@ -193355,7 +193355,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", "in": "query", "required": false, "schema": { @@ -193364,7 +193364,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", "in": "query", "required": false, "schema": { @@ -209949,7 +209949,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", "in": "query", "required": false, "schema": { @@ -209958,7 +209958,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", "in": "query", "required": false, "schema": { @@ -273083,7 +273083,7 @@ }, { "name": "sort", - "description": "The property to sort the results by. created means when the repository was starred. updated means when the repository was last pushed to.
The property to sort the results by.
", "in": "query", "required": false, "schema": { @@ -338524,7 +338524,7 @@ } ], "previews": [], - "descriptionHTML": "Lists all organizations, in the order that they were created on GitHub Enterprise Server.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
Lists all organizations, in the order that they were created on GitHub Enterprise Server.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", "in": "query", "required": false, "schema": { @@ -339871,7 +339871,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", "in": "query", "required": false, "schema": { @@ -376716,7 +376716,7 @@ }, { "name": "sort", - "description": "The property to sort the results by. created means when the repository was starred. updated means when the repository was last pushed to.
The property to sort the results by.
", "in": "query", "required": false, "schema": { @@ -429927,7 +429927,7 @@ } ], "previews": [], - "descriptionHTML": "Lists all public repositories in the order that they were created.
\nNote:
\nsince parameter. Use the Link header to get the URL for the next page of repositories.Lists all public repositories in the order that they were created.
\nNote:
\nsince parameter. Use the Link header to get the URL for the next page of repositories.A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", "in": "query", "required": false, "schema": { @@ -454083,7 +454083,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", "in": "query", "required": false, "schema": { @@ -455425,7 +455425,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.
", "in": "query", "required": false, "schema": { @@ -455434,7 +455434,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.
", "in": "query", "required": false, "schema": { @@ -456785,7 +456785,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.
", "in": "query", "required": false, "schema": { @@ -456794,7 +456794,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.
", "in": "query", "required": false, "schema": { @@ -486825,7 +486825,7 @@ } ], "previews": [], - "descriptionHTML": "Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.
Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.
A project in the organization was closed.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "closed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "A GitHub organization.
", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "projects_v2", - "in": "body", - "description": "A projects v2 project
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "object", - "name": "creator", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "short_description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "deleted_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "deleted_by", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "closed", - "category": "projects_v2" - }, - "created": { - "descriptionHtml": "A project in the organization was created.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "A GitHub organization.
", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "projects_v2", - "in": "body", - "description": "A projects v2 project
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "object", - "name": "creator", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "short_description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "deleted_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "deleted_by", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "created", - "category": "projects_v2" - }, - "edited": { - "descriptionHtml": "The title, description, or README of a project in the organization was changed.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "edited" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "description", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "from", - "description": "" - }, - { - "type": "string or null", - "name": "to", - "description": "" - } - ] - }, - { - "type": "object", - "name": "public", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "from", - "description": "" - }, - { - "type": "boolean", - "name": "to", - "description": "" - } - ] - }, - { - "type": "object", - "name": "short_description", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "from", - "description": "" - }, - { - "type": "string or null", - "name": "to", - "description": "" - } - ] - }, - { - "type": "object", - "name": "title", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "" - }, - { - "type": "string", - "name": "to", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "A GitHub organization.
", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "projects_v2", - "in": "body", - "description": "A projects v2 project
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "object", - "name": "creator", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "short_description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "deleted_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "deleted_by", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "edited", - "category": "projects_v2" - }, - "reopened": { - "descriptionHtml": "A project in the organization was reopened.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "reopened" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "A GitHub organization.
", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "projects_v2", - "in": "body", - "description": "A projects v2 project
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "object", - "name": "creator", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "short_description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "deleted_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "deleted_by", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "reopened", - "category": "projects_v2" - } - }, "projects_v2_item": { "archived": { "descriptionHtml": "An item on an organization project was archived. For more information, see \"Archiving items from your project.\"
", diff --git a/src/webhooks/data/ghes-3.8/schema.json b/src/webhooks/data/ghes-3.8/schema.json index 009da2f437..b442d1c156 100644 --- a/src/webhooks/data/ghes-3.8/schema.json +++ b/src/webhooks/data/ghes-3.8/schema.json @@ -74973,2109 +74973,6 @@ "category": "project_column" } }, - "projects_v2": { - "closed": { - "descriptionHtml": "A project in the organization was closed.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "closed" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "A GitHub organization.
", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "projects_v2", - "in": "body", - "description": "A projects v2 project
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "object", - "name": "creator", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "short_description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "deleted_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "deleted_by", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "closed", - "category": "projects_v2" - }, - "created": { - "descriptionHtml": "A project in the organization was created.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "A GitHub organization.
", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "projects_v2", - "in": "body", - "description": "A projects v2 project
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "object", - "name": "creator", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "short_description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "deleted_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "deleted_by", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "created", - "category": "projects_v2" - }, - "edited": { - "descriptionHtml": "The title, description, or README of a project in the organization was changed.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "edited" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "changes", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "description", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "from", - "description": "" - }, - { - "type": "string or null", - "name": "to", - "description": "" - } - ] - }, - { - "type": "object", - "name": "public", - "description": "", - "childParamsGroups": [ - { - "type": "boolean", - "name": "from", - "description": "" - }, - { - "type": "boolean", - "name": "to", - "description": "" - } - ] - }, - { - "type": "object", - "name": "short_description", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "from", - "description": "" - }, - { - "type": "string or null", - "name": "to", - "description": "" - } - ] - }, - { - "type": "object", - "name": "title", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "" - }, - { - "type": "string", - "name": "to", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "A GitHub organization.
", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "projects_v2", - "in": "body", - "description": "A projects v2 project
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "object", - "name": "creator", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "short_description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "deleted_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "deleted_by", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "edited", - "category": "projects_v2" - }, - "reopened": { - "descriptionHtml": "A project in the organization was reopened.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "reopened" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "A GitHub organization.
", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "projects_v2", - "in": "body", - "description": "A projects v2 project
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "number", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "owner", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "object", - "name": "creator", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "string", - "name": "title", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "public", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "closed_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "short_description", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "deleted_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "deleted_by", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "organization" - ], - "action": "reopened", - "category": "projects_v2" - } - }, "projects_v2_item": { "archived": { "descriptionHtml": "An item on an organization project was archived. For more information, see \"Archiving items from your project.\"
", diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index fd6e177549..ad22e35bf1 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "4aac28959ee19a97c78a7c6ac92b1a5dd0fa325c" + "sha": "05d63e60a5b980d9c08449e6f876d6a28a320fe4" } \ No newline at end of file diff --git a/tests/fixtures/content/get-started/liquid/index.md b/tests/fixtures/content/get-started/liquid/index.md index 2528de8614..e4b8565566 100644 --- a/tests/fixtures/content/get-started/liquid/index.md +++ b/tests/fixtures/content/get-started/liquid/index.md @@ -16,4 +16,5 @@ children: - /whitespace - /table-row-headers - /ifversion + - /links-with-liquid --- diff --git a/tests/fixtures/content/get-started/liquid/links-with-liquid.md b/tests/fixtures/content/get-started/liquid/links-with-liquid.md new file mode 100644 index 0000000000..26fe0ebbc4 --- /dev/null +++ b/tests/fixtures/content/get-started/liquid/links-with-liquid.md @@ -0,0 +1,16 @@ +--- +title: Links with Liquid +intro: When Liquid is used to generate a Markdown link +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +type: how_to +--- + +## Introduction + +You can see pricing and a full list of features for each product at <{% data variables.product.pricing_url %}>. + +Go to [Pricing]({% data variables.product.pricing_url %}) page. diff --git a/tests/rendering-fixtures/liquid.js b/tests/rendering-fixtures/liquid.js index 3cdf627c52..ab4f353c59 100644 --- a/tests/rendering-fixtures/liquid.js +++ b/tests/rendering-fixtures/liquid.js @@ -1,3 +1,4 @@ +import { getDataByLanguage } from '../../lib/get-data.js' import { getDOM } from '../helpers/e2etest.js' describe('extended Markdown', () => { @@ -211,3 +212,21 @@ describe('extended Markdown', () => { } ) }) + +describe('misc Liquid', () => { + test('links with liquid from data', async () => { + const $ = await getDOM('/get-started/liquid/links-with-liquid') + // The URL comes from variables.product.pricing_url + const url = getDataByLanguage('variables.product.pricing_url', 'en') + if (!url) throw new Error('variable could not be found') + const links = $(`#article-contents a[href="${url}"]`) + expect(links.length).toBe(2) + const texts = links + .map((i, element) => { + return $(element).text() + }) + .get() + expect(texts[0]).toBe(url) + expect(texts[1]).toBe('Pricing') + }) +}) diff --git a/tests/rendering/server.js b/tests/rendering/server.js index 0a18591954..a9c53321d3 100644 --- a/tests/rendering/server.js +++ b/tests/rendering/server.js @@ -230,16 +230,6 @@ describe('server', () => { }) }) - test('renders Markdown links that have Liquid hrefs', async () => { - // example from markdown source: - // 1. Go to {{ site.data.variables.product.product_name }}'s [Pricing]({{ site.data.variables.dotcom_billing.plans_url }}) page. - const $ = await getDOM( - '/en/github/getting-started-with-github/signing-up-for-a-new-github-account' - ) - expect($.text()).toContain("Go to GitHub's Pricing page.") - expect($('a[href="https://github.com/pricing"]').first().text()).toBe('Pricing') - }) - test('renders liquid within liquid within liquid in body text', async () => { const $ = await getDOM('/en/github/administering-a-repository/enabling-required-status-checks') expect($('ol li').first().text().trim()).toBe( diff --git a/tests/unit/get-remote-json.js b/tests/unit/get-remote-json.js new file mode 100644 index 0000000000..5c2acb92dc --- /dev/null +++ b/tests/unit/get-remote-json.js @@ -0,0 +1,115 @@ +import fs from 'fs' +import path from 'path' +import os from 'os' + +import rimraf from 'rimraf' +import { expect, test, describe, beforeAll, afterAll } from '@jest/globals' +import nock from 'nock' +import getRemoteJSON, { cache } from '../../middleware/get-remote-json.js' + +/** + * + * These unit tests test that the in-memory cache works and when it's + * not a cache it, it can benefit from using the disk cache. + */ + +describe('getRemoteJSON', () => { + const envVarValueBefore = process.env.GET_REMOTE_JSON_DISK_CACHE_ROOT + const tempDir = path.join(os.tmpdir(), 'remotejson-test') + + beforeAll(() => { + process.env.GET_REMOTE_JSON_DISK_CACHE_ROOT = tempDir + }) + + afterAll(() => { + process.env.GET_REMOTE_JSON_DISK_CACHE_ROOT = envVarValueBefore + rimraf.sync(tempDir) + }) + + afterEach(() => { + nock.cleanAll() + }) + + test('simple in-memory caching', async () => { + const url = 'http://example.com/redirects.json' + const { origin, pathname } = new URL(url) + nock(origin).get(pathname).reply(200, { foo: 'bar' }) + const data = await getRemoteJSON(url, {}) + expect(data.foo).toBe('bar') + expect(cache.get(url)).toBeTruthy() + // Second time, despite not setting up a second nock(), will work + // because it can use memory now. + const data2 = await getRemoteJSON(url, {}) + expect(data2.foo).toBe('bar') + expect(cache.get(url)).toBeTruthy() + }) + + test('benefit from disk-based caching', async () => { + const url = 'http://example.com/cool.json' + const { origin, pathname } = new URL(url) + nock(origin).get(pathname).reply(200, { cool: true }) + const data = await getRemoteJSON(url, {}) + expect(data.cool).toBe(true) + expect(cache.get(url)).toBeTruthy() + cache.delete(url) + + // This time, the nock won't fail despite not using `.persist()`. + // That means it didn't need the network because it was able to + // use the disk cache. + const data2 = await getRemoteJSON(url, {}) + expect(data2.cool).toBe(true) + }) + + test('recover from disk corruption (empty)', async () => { + const tempTempDir = path.join(tempDir, 'empty-files') + process.env.GET_REMOTE_JSON_DISK_CACHE_ROOT = tempTempDir + const url = 'http://example.com/empty.json' + const { origin, pathname } = new URL(url) + nock(origin).get(pathname).reply(200, { cool: true }) + await getRemoteJSON(url, {}) + + // Make every file in the cache directory an empty file + for (const file of fs.readdirSync(tempTempDir)) { + fs.writeFileSync(path.join(tempTempDir, file), '') + } + + cache.delete(url) + // If we don't do this, nock will fail because a second network + // request became necessary. + nock(origin).get(pathname).reply(200, { cool: true }) + + const data = await getRemoteJSON(url, {}) + expect(data.cool).toBe(true) + }) + + test('recover from disk corruption (bad JSON)', async () => { + const tempTempDir = path.join(tempDir, 'corrupt-files') + process.env.GET_REMOTE_JSON_DISK_CACHE_ROOT = tempTempDir + const url = 'http://example.com/corrupt.json' + const { origin, pathname } = new URL(url) + nock(origin).get(pathname).reply(200, { cool: true }) + await getRemoteJSON(url, {}) + + // Make every file in the cache directory an empty file + for (const file of fs.readdirSync(tempTempDir)) { + fs.writeFileSync(path.join(tempTempDir, file), '{"not:JSON{') + } + + cache.delete(url) + // If we don't do this, nock will fail because a second network + // request became necessary. + nock(origin).get(pathname).reply(200, { cool: true }) + + const data = await getRemoteJSON(url, {}) + expect(data.cool).toBe(true) + }) + + test('not-actually JSON despite URL', async () => { + const url = 'http://example.com/might-look-like.json' + const { origin, pathname } = new URL(url) + nock(origin).get(pathname).reply(200, 'here', { + 'Content-Type': 'text/html', + }) + await expect(getRemoteJSON(url, {})).rejects.toThrowError(/resulted in a non-JSON response/) + }) +})